Commit d6bd78f
doc,net: document socket.timeout
PR-URL: #34543
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Harshitha K P <harshitha014@gmail.com>
Reviewed-By: Pranshu Srivastava <rexagod@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Denys Otrishko <shishugi@gmail.com>1 parent 99cb362 commit d6bd78f
1 file changed
Lines changed: 10 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -998,6 +998,16 @@ If `timeout` is 0, then the existing idle timeout is disabled. | |||
| 998 | 998 | The optional `callback` parameter will be added as a one-time listener for the | |
| 999 | 999 | [`'timeout'`][] event. | |
| 1000 | 1000 | ||
| 1001 | + ### `socket.timeout` | ||
| 1002 | + <!-- YAML | ||
| 1003 | + added: v10.7.0 | ||
| 1004 | + --> | ||
| 1005 | + | ||
| 1006 | + * {number|undefined} | ||
| 1007 | + | ||
| 1008 | + The socket timeout in milliseconds as set by [`socket.setTimeout()`][]. | ||
| 1009 | + It is `undefined` if a timeout has not been set. | ||
| 1010 | + | ||
| 1001 | 1011 | ### `socket.unref()` | |
| 1002 | 1012 | <!-- YAML | |
| 1003 | 1013 | added: v0.9.1 | |
0 commit comments