From d6bd78ff82de22992c34d80e5932cdb3d66ba983 Mon Sep 17 00:00:00 2001 From: kobelb Date: Tue, 28 Jul 2020 16:57:31 -0700 Subject: [PATCH] doc,net: document socket.timeout PR-URL: https://github.com/nodejs/node/pull/34543 Reviewed-By: Rich Trott Reviewed-By: Trivikram Kamat Reviewed-By: Harshitha K P Reviewed-By: Pranshu Srivastava Reviewed-By: James M Snell Reviewed-By: Luigi Pinca Reviewed-By: Denys Otrishko --- doc/api/net.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/api/net.md b/doc/api/net.md index e8a33fc4f08cbe..7e3492b4b7b0b1 100644 --- a/doc/api/net.md +++ b/doc/api/net.md @@ -998,6 +998,16 @@ If `timeout` is 0, then the existing idle timeout is disabled. The optional `callback` parameter will be added as a one-time listener for the [`'timeout'`][] event. +### `socket.timeout` + + +* {number|undefined} + +The socket timeout in milliseconds as set by [`socket.setTimeout()`][]. +It is `undefined` if a timeout has not been set. + ### `socket.unref()`