Skip to content

Commit 138eda8

Browse files
denghongcaifengmk2
authored andcommitted
doc: fix keepAliveMsecs params description (#55)
nodejs/node#7335
1 parent 7c46df1 commit 138eda8

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ $ npm install agentkeepalive --save
4444
Can have the following fields:
4545
* `keepAlive` {Boolean} Keep sockets around in a pool to be used by
4646
other requests in the future. Default = `true`.
47-
* `keepAliveMsecs` {Number} When using HTTP KeepAlive, how often
48-
to send TCP KeepAlive packets over sockets being kept alive.
47+
* `keepAliveMsecs` {Number} When using the keepAlive option, specifies the initial delay
48+
for TCP Keep-Alive packets. Ignored when the keepAlive option is false or undefined. Defaults to 1000.
4949
Default = `1000`. Only relevant if `keepAlive` is set to `true`.
5050
* `freeSocketKeepAliveTimeout`: {Number} Sets the free socket to timeout
5151
after `freeSocketKeepAliveTimeout` milliseconds of inactivity on the free socket.

0 commit comments

Comments
 (0)