Permalink
Browse files

doc: fix http.Agent timeout option description

By default the agent options are passed to `net.createConnection()`
which sets the timeout on the socket immediately after creating it.

PR-URL: #25489
Reviewed-By: Anna Henningsen <anna@addaleax.net>
  • Loading branch information...
lpinca authored and addaleax committed Jan 14, 2019
1 parent bc81fef commit 1d6e18b1289c71ec2f8c4946961066896d72da0b
Showing with 1 addition and 1 deletion.
  1. +1 −1 doc/api/http.md
@@ -127,7 +127,7 @@ added: v0.3.4
in a free state. Only relevant if `keepAlive` is set to `true`.
**Default:** `256`.
* `timeout` {number} Socket timeout in milliseconds.
This will set the timeout after the socket is connected.
This will set the timeout when the socket is created.

`options` in [`socket.connect()`][] are also supported.

0 comments on commit 1d6e18b

Please sign in to comment.