Skip to content

Commit c47c764

Browse files
Krinklejasnell
authored andcommitted
doc: fix "initial delay" link in http.md
Refs: #10715 PR-URL: #11108 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent d6b8e75 commit c47c764

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

doc/api/http.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -100,11 +100,13 @@ added: v0.3.4
100100

101101
* `options` {Object} Set of configurable options to set on the agent.
102102
Can have the following fields:
103-
* `keepAlive` {Boolean} Keep sockets around in a pool to be used by
104-
other requests in the future. Default = `false`
105-
* `keepAliveMsecs` {Integer} When using HTTP KeepAlive, how often
106-
to send TCP KeepAlive packets over sockets being kept alive.
107-
Default = `1000`. Only relevant if `keepAlive` is set to `true`.
103+
* `keepAlive` {Boolean} Keep sockets around even when there are no
104+
outstanding requests, so they can be used for future requests without
105+
having to reestablish a TCP connection. Default = `false`
106+
* `keepAliveMsecs` {Integer} When using the `keepAlive` option, specifies
107+
the [initial delay](net.html#net_socket_setkeepalive_enable_initialdelay)
108+
for TCP Keep-Alive packets. Ignored when the
109+
`keepAlive` option is `false` or `undefined`. Default = `1000`.
108110
* `maxSockets` {Number} Maximum number of sockets to allow per
109111
host. Default = `Infinity`.
110112
* `maxFreeSockets` {Number} Maximum number of sockets to leave open

0 commit comments

Comments
 (0)