summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorLuigi Pinca <luigipinca@gmail.com>2019-01-14 10:20:34 +0100
committerAnna Henningsen <anna@addaleax.net>2019-01-29 00:09:37 +0100
commit9dc11764f27f701c5d3f027cfabec00a2d8222e1 (patch)
treecbc1d717db2558fa85d24be353c7b02fb274b35c /doc/api
parent817218c9cfd78feaef720b0055cd18d08f774400 (diff)
downloadandroid-node-v8-9dc11764f27f701c5d3f027cfabec00a2d8222e1.tar.gz
android-node-v8-9dc11764f27f701c5d3f027cfabec00a2d8222e1.tar.bz2
android-node-v8-9dc11764f27f701c5d3f027cfabec00a2d8222e1.zip
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: https://github.com/nodejs/node/pull/25489 Reviewed-By: Anna Henningsen <anna@addaleax.net>
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/http.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/api/http.md b/doc/api/http.md
index e4474c773a..592d2a1609 100644
--- a/doc/api/http.md
+++ b/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.