From 91666014d5f30e60414d0aff897c5815f0edf097 Mon Sep 17 00:00:00 2001 From: Brandon Kobel Date: Mon, 10 Aug 2020 18:54:49 -0700 Subject: [PATCH] doc: make it more obvious that net.Socket#timeout is potentially undefined Co-authored-by: Rich Trott --- doc/api/net.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/api/net.md b/doc/api/net.md index dba98062486cca..e4c758aeaf01a6 100644 --- 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()`