From 0a5a762a16224479003dd44b7855b236fc481de9 Mon Sep 17 00:00:00 2001 From: Luigi Pinca Date: Sat, 30 Mar 2019 09:55:28 +0100 Subject: doc: improve the doc of the 'information' event - Add missing argument - Reword a sentence - Rename the `res` argument to `info` in the example to avoid confusion PR-URL: https://github.com/nodejs/node/pull/27009 Fixes: https://github.com/nodejs/node/issues/26905 Reviewed-By: Ruben Bridgewater Reviewed-By: Daniel Bevenius --- doc/api/http.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) (limited to 'doc/api/http.md') diff --git a/doc/api/http.md b/doc/api/http.md index 455195d79f..927e64554e 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -416,8 +416,11 @@ the client should send the request body. added: v10.0.0 --> -Emitted when the server sends a 1xx response (excluding 101 Upgrade). This -event is emitted with a callback containing an object with a status code. +* `info` {Object} + * `statusCode` {integer} + +Emitted when the server sends a 1xx response (excluding 101 Upgrade). The +listeners of this event will receive an object containing the status code. ```js const http = require('http'); @@ -432,8 +435,8 @@ const options = { const req = http.request(options); req.end(); -req.on('information', (res) => { - console.log(`Got information prior to main response: ${res.statusCode}`); +req.on('information', (info) => { + console.log(`Got information prior to main response: ${info.statusCode}`); }); ``` -- cgit v1.2.3