Skip to content

Commit 9166601

Browse files
kobelbTrott
andauthored
doc: make it more obvious that net.Socket#timeout is potentially undefined
Co-authored-by: Rich Trott <rtrott@gmail.com>
1 parent 2841e70 commit 9166601

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

doc/api/net.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -919,9 +919,10 @@ The optional `callback` parameter will be added as a one-time listener for the
919919
added: v10.7.0
920920
-->
921921

922-
* {number}
922+
* {number|undefined}
923923

924-
Returns the read-only socket timeout in milliseconds.
924+
The socket timeout in milliseconds as set by [`socket.setTimeout()`][].
925+
It is `undefined` if a timeout has not been set.
925926

926927
### `socket.unref()`
927928
<!-- YAML

0 commit comments

Comments
 (0)