Skip to content

Commit

Permalink
doc: update http doc for new Agent()/support options in socket.connect()
Browse files Browse the repository at this point in the history
For new Agent() signature in http doc, list the supported options in
socket.connect().

Refs: #24098

PR-URL: #24846
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
  • Loading branch information
BeniCheni authored and BethGriggs committed Dec 17, 2018
1 parent f41443c commit 81dce68
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/api/http.md
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

0 comments on commit 81dce68

Please sign in to comment.