Skip to content

Commit 2f8722b

Browse files
kobelbBethGriggs
authored andcommitted
doc,net: document socket.timeout
PR-URL: #34543 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Harshitha K P <[email protected]> Reviewed-By: Pranshu Srivastava <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Denys Otrishko <[email protected]>
1 parent 66bd12e commit 2f8722b

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

doc/api/net.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -934,6 +934,16 @@ If `timeout` is 0, then the existing idle timeout is disabled.
934934
The optional `callback` parameter will be added as a one-time listener for the
935935
[`'timeout'`][] event.
936936

937+
### `socket.timeout`
938+
<!-- YAML
939+
added: v10.7.0
940+
-->
941+
942+
* {number|undefined}
943+
944+
The socket timeout in milliseconds as set by [`socket.setTimeout()`][].
945+
It is `undefined` if a timeout has not been set.
946+
937947
### `socket.unref()`
938948
<!-- YAML
939949
added: v0.9.1

0 commit comments

Comments
 (0)