Skip to content

Commit 81dce68

Browse files
BeniCheniBethGriggs
authored andcommitted
doc: update http doc for new Agent()/support options in socket.connect()
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>
1 parent f41443c commit 81dce68

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

doc/api/http.md

+3
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,8 @@ added: v0.3.4
129129
* `timeout` {number} Socket timeout in milliseconds.
130130
This will set the timeout after the socket is connected.
131131

132+
`options` in [`socket.connect()`][] are also supported.
133+
132134
The default [`http.globalAgent`][] that is used by [`http.request()`][] has all
133135
of these values set to their respective defaults.
134136

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

0 commit comments

Comments
 (0)