René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"doc(tls): tls.connect() supports timeout option but it is undocumented and misleadingly described","articleBody":"### Affected URL(s)\n\nhttps://nodejs.org/api/tls.html#tlsconnectoptions-callback\n\n### Description of the problem\n\n`tls.connect()` supports the `timeout` option, but it is currently undocumented in the API reference.\nAlthough the history indicates that `timeout` support was added in `v11.8.0, v10.16.0`, the corresponding documentation entry was later accidentally removed. As a result, the current docs are incomplete and misleading.\n\n## Actual Behavior\n\n- `tls.connect({ timeout })` works as expected and is supported in practice\n- But it is not documented anywhere in the current API reference\n\n## Expected Behavior\n\nExplicitly document the `timeout` option in `tls.connect()` options.\n\n## Background\n\nHistorically, when timeout support was introduced to `tls.connect()`, it was properly documented.\nHowever, in a later commit, the documentation was removed unintentionally:\n\nDocumentation removal commit: https://github.com/nodejs/node/commit/ff8539e9e747db61a2adac6d4498ef4ee5826900\n\nCurrently, the `tls.connect()` options section contains the following description:\n\n\u003e …: Any `socket.connect()` option not already listed.\n\nThis wording strongly suggests that `timeout` is inherited from `socket.connect()`.\nHowever, this is *incorrect*:\n\n- timeout is not an option of `socket.connect()`\n- timeout is defined on `net.createConnection(options[, connectListener])`\n\nThis mismatch makes it very easy for users to misinterpret where timeout support comes from and whether it is officially supported.\n","author":{"url":"https://github.com/ikeyan","@type":"Person","name":"ikeyan"},"datePublished":"2025-12-15T17:25:07.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/61075/node/issues/61075"}