diff options
author | Luigi Pinca <luigipinca@gmail.com> | 2020-10-01 11:43:13 +0300 |
---|---|---|
committer | Luigi Pinca <luigipinca@gmail.com> | 2020-10-04 08:49:22 +0300 |
commit | 2979721e1c1dbe9327556f92d5dbefd5c0d3da19 (patch) | |
tree | e8ecad31b3c0adfb0563c876c8f305806861be55 | |
parent | f83f6830437a57bd4460a378b6296bd7cd2e1104 (diff) |
doc: avoid using deprecated connection property
`request.connection` and `response.connection` are deprecated. Use
`request.socket` and `response.socket` instead.
PR-URL: https://github.com/nodejs/node/pull/35439
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Pranshu Srivastava <rexagod@gmail.com>
Reviewed-By: Harshitha K P <harshitha014@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
-rw-r--r-- | doc/api/http.md | 10 |
1 files changed, 4 insertions, 6 deletions
diff --git a/doc/api/http.md b/doc/api/http.md index 3e140dab961..640fb041dd0 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -926,8 +926,7 @@ added: v0.3.0 Reference to the underlying socket. Usually users will not want to access this property. In particular, the socket will not emit `'readable'` events -because of how the protocol parser attaches to the socket. The `socket` -may also be accessed via `request.connection`. +because of how the protocol parser attaches to the socket. ```js const http = require('http'); @@ -1157,7 +1156,7 @@ This event is emitted when a new TCP stream is established. `socket` is typically an object of type [`net.Socket`][]. Usually users will not want to access this event. In particular, the socket will not emit `'readable'` events because of how the protocol parser attaches to the socket. The `socket` can -also be accessed at `request.connection`. +also be accessed at `request.socket`. This event can also be explicitly emitted by users to inject connections into the HTTP server. In that case, any [`Duplex`][] stream can be passed. @@ -1658,8 +1657,7 @@ added: v0.3.0 Reference to the underlying socket. Usually users will not want to access this property. In particular, the socket will not emit `'readable'` events because of how the protocol parser attaches to the socket. After -`response.end()`, the property is nulled. The `socket` may also be accessed -via `response.connection`. +`response.end()`, the property is nulled. ```js const http = require('http'); @@ -2059,7 +2057,7 @@ added: v0.5.9 * `callback` {Function} * Returns: {http.IncomingMessage} -Calls `message.connection.setTimeout(msecs, callback)`. +Calls `message.socket.setTimeout(msecs, callback)`. ### `message.socket` <!-- YAML |