Skip to content

doc: clarify socket.setKeepAlive initialDelay arg #62171

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

Open
efekrskl wants to merge 2 commits into
base: main
Choose a base branch
from
+4 −0
Open

doc: clarify socket.setKeepAlive initialDelay arg #62171

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
288a6eb
doc: clarify socket.setKeepAlive initialDelay arg
efekrskl Mar 9, 2026
e0814bc
doc: better examples
efekrskl Mar 29, 2026
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
4 changes: 4 additions & 0 deletions doc/api/net.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1402,6 +1402,10 @@ data packet received and the first keepalive probe. Setting `0` for
`initialDelay` will leave the value unchanged from the default
(or previous) setting.

**Note**: Node.js converts initialDelay from milliseconds to seconds and truncates any fractional part.
For example, `setKeepAlive(true, 500)` does not update the delay because it is truncated to `0`, leaving the value
unchanged, while `setKeepAlive(true, 1500)` sets it to `1` second.

Enabling the keep-alive functionality will set the following socket options:

* `SO_KEEPALIVE=1`
Expand Down
Loading