Skip to content

Commit

Permalink
doc: update the http.request.setTimeout docs to be accurate
Browse files Browse the repository at this point in the history
Refs: #8895

PR-URL: #25123
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
jbunton-atlassian authored and MylesBorins committed Dec 26, 2018
1 parent 8810051 commit 3af7528
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions doc/api/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -625,8 +625,9 @@ added: v0.5.9
* `timeout` {number} Milliseconds before a request times out.
* `callback` {Function} Optional function to be called when a timeout occurs. Same as binding to the `timeout` event.

Once a socket is assigned to this request and is connected
[`socket.setTimeout()`][] will be called.
If no socket is assigned to this request then [`socket.setTimeout()`][] will be
called immediately. Otherwise [`socket.setTimeout()`][] will be called after the
assigned socket is connected.

Returns `request`.

Expand Down

0 comments on commit 3af7528

Please sign in to comment.