Skip to content

Commit

Permalink
doc: fix http.Agent timeout option description
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
lpinca authored and addaleax committed Jan 28, 2019
1 parent bc81fef commit 1d6e18b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/api/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 1d6e18b

Please sign in to comment.