From 89d30908f2c1c00c73feddd4ed3e075a24335f9e Mon Sep 17 00:00:00 2001 From: Timo Tijhof Date: Wed, 1 Feb 2017 19:21:46 +0000 Subject: [PATCH] doc: fix "initial delay" link in http.md Refs: https://github.com/nodejs/node/pull/10715 PR-URL: https://github.com/nodejs/node/pull/11108 Reviewed-By: James M Snell Reviewed-By: Luigi Pinca --- doc/api/http.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/doc/api/http.md b/doc/api/http.md index e725bf83937d57..ac54f57611b042 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -100,11 +100,13 @@ added: v0.3.4 * `options` {Object} Set of configurable options to set on the agent. Can have the following fields: - * `keepAlive` {Boolean} Keep sockets around in a pool to be used by - other requests in the future. Default = `false` - * `keepAliveMsecs` {Integer} When using HTTP KeepAlive, how often - to send TCP KeepAlive packets over sockets being kept alive. - Default = `1000`. Only relevant if `keepAlive` is set to `true`. + * `keepAlive` {Boolean} Keep sockets around even when there are no + outstanding requests, so they can be used for future requests without + having to reestablish a TCP connection. Default = `false` + * `keepAliveMsecs` {Integer} When using the `keepAlive` option, specifies + the [initial delay](net.html#net_socket_setkeepalive_enable_initialdelay) + for TCP Keep-Alive packets. Ignored when the + `keepAlive` option is `false` or `undefined`. Default = `1000`. * `maxSockets` {Number} Maximum number of sockets to allow per host. Default = `Infinity`. * `maxFreeSockets` {Number} Maximum number of sockets to leave open