doc: make it more obvious that net.Socket#timeout is potentially unde…

…fined Co-authored-by: Rich Trott <[email protected]>
nodejs · Aug 11, 2020 · 9166601 · 9166601
1 parent 2841e70
commit 9166601
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/doc/api/net.md b/doc/api/net.md
@@ -919,9 +919,10 @@ The optional `callback` parameter will be added as a one-time listener for the
 added: v10.7.0
 -->
 
-* {number}
+* {number|undefined}
 
-Returns the read-only socket timeout in milliseconds.
+The socket timeout in milliseconds as set by [`socket.setTimeout()`][].
+It is `undefined` if a timeout has not been set.
 
 ### `socket.unref()`
 <!-- YAML