doc: document timeout option for tls.connect() #61079
Open
+7
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
doc
azadgupta1
force-pushed
the
doc-tls-connect-timeout
branch
2 times, most recently
from
9d8df44 to
3b73269
Compare
azadgupta1
force-pushed
the
doc-tls-connect-timeout
branch
from
3b73269 to
6c306b6
Compare
azadgupta1
force-pushed
the
doc-tls-connect-timeout
branch
2 times, most recently
from
78da2b7 to
fb40d84
Compare
azadgupta1
force-pushed
the
doc-tls-connect-timeout
branch
from
fb40d84 to
6bd585e
Compare
|
@azadgupta1 The |
lpinca
reviewed
Dec 28, 2025
Comment on lines
+1733
to
+1736
| * `timeout` {number} Sets the socket to timeout after `timeout` milliseconds | ||
| of inactivity. By default, no timeout is set. This option is supported | ||
| because `tls.connect()` internally uses [`net.createConnection()`][] | ||
| and is equivalent to calling [`socket.setTimeout()`][] on the returned socket. |
Member
There was a problem hiding this comment.
The original description (ff8539e) is more concise and accurate, can you please restore it?
| @@ -1740,7 +1744,7 @@ changes: | |||
| `onread` option of [`net.Socket`][] for details. | |||
| * ...: [`tls.createSecureContext()`][] options that are used if the | |||
| `secureContext` option is missing, otherwise they are ignored. | |||
| * ...: Any [`socket.connect()`][] option not already listed. | |||
| * ...: Any [`net.createConnection()`][] option not already listed. | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #61075
This PR documents the
timeoutoption supported bytls.connect()sincev11.8.0 / v10.16.0 and fixes misleading wording suggesting it comes from
socket.connect(). The option is inherited fromnet.createConnection()and is equivalent to calling
socket.setTimeout().