Skip to content

doc: clarify setKeepAlive delay precision#63339

Open
MukundaKatta wants to merge 1 commit into
nodejs:mainfrom
MukundaKatta:codex/doc-setkeepalive-delay-seconds
Open

doc: clarify setKeepAlive delay precision#63339
MukundaKatta wants to merge 1 commit into
nodejs:mainfrom
MukundaKatta:codex/doc-setkeepalive-delay-seconds

Conversation

@MukundaKatta
Copy link
Copy Markdown

Fixes: #57712

This updates the net docs to clarify that socket.setKeepAlive() and the related keepAliveInitialDelay options accept milliseconds but are rounded down to whole seconds before use.

It also explicitly calls out that values below 1000 ms become 0, which leaves the value unchanged from the default or previous setting.

Validation:

  • git diff --check
  • node tools/lint-md/lint-md.mjs doc/api/net.md

@nodejs-github-bot
Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/net

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem. labels May 15, 2026
Signed-off-by: mukunda katta <mukunda.vjcs6@gmail.com>
@MukundaKatta MukundaKatta force-pushed the codex/doc-setkeepalive-delay-seconds branch from 695766d to 3889769 Compare May 15, 2026 20:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

setkeepalive < 1000 silently ignored

3 participants