Skip to content

Commit b17819d

Browse files
jbunton-atlassianrvagg
authored andcommittedFeb 28, 2019
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>
1 parent a1aff28 commit b17819d

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed
 

‎doc/api/http.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -625,8 +625,9 @@ added: v0.5.9
625625
* `timeout` {number} Milliseconds before a request times out.
626626
* `callback` {Function} Optional function to be called when a timeout occurs. Same as binding to the `timeout` event.
627627

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

631632
Returns `request`.
632633

0 commit comments

Comments
 (0)
Please sign in to comment.