Skip to content

Commit 2abc9d4

Browse files
committed
doc: fix tls.connect() timeout documentation
1 parent 6c306b6 commit 2abc9d4

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

doc/api/tls.md

Lines changed: 5 additions & 1 deletion
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
@@ -2478,7 +2481,8 @@ added: v0.11.3
24782481
[`server.getTicketKeys()`]: #servergetticketkeys
24792482
[`server.listen()`]: net.md#serverlisten
24802483
[`server.setTicketKeys()`]: #serversetticketkeyskeys
2481-
[`socket.connect()`]: net.md#socketconnectoptions-connectlistener
2484+
[`socket.setTimeout(timeout)`]: #net_socket_settimeout_timeout_callback
2485+
[`socket.connect()`]: net.html#net_socket_connect_options_connectlistener
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)