Skip to content

[v8.x] update the http.request.setTimeout docs to be accurate #25123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jbunton-atlassian wants to merge 2 commits into from
Closed

[v8.x] update the http.request.setTimeout docs to be accurate #25123

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae24aaf
deps: cherry-pick 525b396 from V8 upstream
psmarshall Dec 14, 2018
fc173b3
doc: update the http.request.setTimeout docs to be accurate
jbunton-atlassian Dec 19, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
doc: update the http.request.setTimeout docs to be accurate 
Refs: #8895
  • Loading branch information
@jbunton-atlassian
jbunton-atlassian committed Dec 19, 2018
commit fc173b3d72262e0871c576b6dd4a92340d7d9260
5 changes: 3 additions & 2 deletions doc/api/http.md
View file
Open in desktop
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