Skip to content

Commit d991f69

Browse files
authored
doc: fix tls.connect() timeout documentation
PR-URL: #61079 Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
1 parent 926162a commit d991f69

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

doc/api/tls.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1730,6 +1730,9 @@ changes:
17301730
**Default:** `1024`.
17311731
* `highWaterMark` {number} Consistent with the readable stream `highWaterMark` parameter.
17321732
**Default:** `16 * 1024`.
1733+
* `timeout`: {number} If set and if a socket is created internally, will call
1734+
[`socket.setTimeout(timeout)`][] after the socket is created, but before it
1735+
starts the connection.
17331736
* `secureContext`: TLS context object created with
17341737
[`tls.createSecureContext()`][]. If a `secureContext` is _not_ provided, one
17351738
will be created by passing the entire `options` object to
@@ -2479,6 +2482,7 @@ added: v0.11.3
24792482
[`server.listen()`]: net.md#serverlisten
24802483
[`server.setTicketKeys()`]: #serversetticketkeyskeys
24812484
[`socket.connect()`]: net.md#socketconnectoptions-connectlistener
2485+
[`socket.setTimeout(timeout)`]: net.md#socketsettimeouttimeout-callback
24822486
[`tls.DEFAULT_ECDH_CURVE`]: #tlsdefault_ecdh_curve
24832487
[`tls.DEFAULT_MAX_VERSION`]: #tlsdefault_max_version
24842488
[`tls.DEFAULT_MIN_VERSION`]: #tlsdefault_min_version

0 commit comments

Comments
 (0)