Skip to content

Commit

Permalink
doc: avoid using deprecated connection property
Browse files Browse the repository at this point in the history
`request.connection` and `response.connection` are deprecated. Use
`request.socket` and `response.socket` instead.

PR-URL: nodejs#35439
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Pranshu Srivastava <[email protected]>
Reviewed-By: Harshitha K P <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Gireesh Punathil <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
  • Loading branch information
lpinca committed Oct 4, 2020
1 parent f83f683 commit 2979721
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions doc/api/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -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');
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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');
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 2979721

Please sign in to comment.