diff options
| author | Beni von Cheni <benjaminlchen@gmail.com> | 2018-12-05 01:41:19 -0500 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2018-12-08 13:32:42 -0800 |
| commit | 22564b99cb9dff471f40c1ad0245d99b9224a207 (patch) | |
| tree | afc50ec5aa9d95ddd1ee20053de889e410a687a7 /doc | |
| parent | 5011dfe4221a3c4f1f421e62a41259f5249b4479 (diff) | |
| download | android-node-v8-22564b99cb9dff471f40c1ad0245d99b9224a207.tar.gz android-node-v8-22564b99cb9dff471f40c1ad0245d99b9224a207.tar.bz2 android-node-v8-22564b99cb9dff471f40c1ad0245d99b9224a207.zip | |
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: https://github.com/nodejs/node/issues/24098
PR-URL: https://github.com/nodejs/node/pull/24846
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/http.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/api/http.md b/doc/api/http.md index d78002f10f..63f4c58a85 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -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. @@ -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 |