Skip to content
Closed
Prev Previous commit
Next Next commit
doc: update the http.request.setTimeout docs to be accurate
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
commit 3af7528ac399e77eca40b2d00a39afb8dc935b95
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