Skip to content
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

Jump to bottom

doc: update http doc for new Agent()/support options in socket.connect() #24846

Closed
wants to merge 2 commits into from
Closed

doc: update http doc for new Agent()/support options in socket.connect() #24846

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d8694e
doc: update http doc for new Agent()/support options in socket.connect()
BeniCheni Dec 5, 2018
7dccf7c
doc: update http doc to rearrange socket.connect() options
BeniCheni Dec 6, 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
3 changes: 3 additions & 0 deletions doc/api/http.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,8 @@ added: v0.3.4
* `timeout` {number} Socket timeout in milliseconds.
This will set the timeout after the socket is connected.

`options` in [`socket.connect()`][] are also supported.

The default [`http.globalAgent`][] that is used by [`http.request()`][] has all
of these values set to their respective defaults.

Expand Down Expand Up @@ -2139,6 +2141,7 @@ not abort the request or do anything besides add a `'timeout'` event.
[`server.listen()`]: net.html#net_server_listen
[`server.timeout`]: #http_server_timeout
[`setHeader(name, value)`]: #http_request_setheader_name_value
[`socket.connect()`]: net.html#net_socket_connect_options_connectlistener
[`socket.setKeepAlive()`]: net.html#net_socket_setkeepalive_enable_initialdelay
[`socket.setNoDelay()`]: net.html#net_socket_setnodelay_nodelay
[`socket.setTimeout()`]: net.html#net_socket_settimeout_timeout_callback
Expand Down