daohualiuxiang
/
node
mirror of https://github.com/nodejs/node.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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 <ruben@bridgewater.de>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
pull/27056/head
Luigi Pinca 2019-03-30 09:55:28 +01:00 committed by Daniel Bevenius
parent dada2eba93
commit 0a5a762a16
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/api/http.md
View File

@ -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}`);
});
```