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: #27009 Fixes: #26905 Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]> Signed-off-by: Beth Griggs <[email protected]>
nodejs · Apr 9, 2019 · 7b37c65 · 7b37c65
1 parent f65cb75
commit 7b37c65
Showing 1 changed file with 7 additions and 4 deletions.
diff --git 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}`);
 });
 ```