Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: add net.Socket#timeout #34543

Closed
wants to merge 3 commits into from
Closed

doc: add net.Socket#timeout #34543

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
317741e
doc: add net.Socket#timeout
kobelb Jul 28, 2020
2841e70
doc: change net.Socket#timeout description
kobelb Jul 29, 2020
9166601
doc: make it more obvious that net.Socket#timeout is potentially unde…
kobelb Aug 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions doc/api/net.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -914,6 +914,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`
<!-- YAML
added: v10.7.0
-->

* {number|undefined}

The socket timeout in milliseconds as set by [`socket.setTimeout()`][].
It is `undefined` if a timeout has not been set.

### `socket.unref()`
<!-- YAML
added: v0.9.1
Expand Down