From f073cda541379845bbdef144c1047a5c31a7ce0b Mon Sep 17 00:00:00 2001 From: Beni von Cheni Date: Wed, 5 Dec 2018 01:41:19 -0500 Subject: [PATCH] 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 Reviewed-By: Luigi Pinca Reviewed-By: Trivikram Kamat --- doc/api/http.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/api/http.md b/doc/api/http.md index d78002f10f17e7..63f4c58a85d9bd 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