doc: clarify sub-1000ms behavior in socket.setKeepAlive - #65869
Merged
Merged
Conversation
The current documentation states that `initialDelay` and `interval` are divided by 1000 and rounded down, but does not explicitly mention that values less than 1000ms will result in 0 seconds. This can lead to confusion when users pass values like 400ms expecting sub-second keepalive delays. Add a concrete example showing that 400ms rounds down to 0 seconds. Refs: nodejs#57712 Signed-off-by: haramjeong <04harams77@gmail.com>
Collaborator
|
Review requested:
|
nodejs-github-bot
added
doc
jasnell
approved these changes
Sep 7, 2026
Member
Author
|
Hi! This PR has been approved and all checks are passing. Would anyone from @nodejs/net be able to take another look when you have a chance? Please let me know if any further changes are needed. Thanks! |
UlisesGascon
approved these changes
Sep 14, 2026
panva
added
the
author ready
inoway46
added
the
commit-queue
Collaborator
|
Landed in 7c01b98 |
nodejs-github-bot
removed
the
commit-queue
aduh95
pushed a commit
that referenced
this pull request
Sep 18, 2026
The current documentation states that `initialDelay` and `interval` are divided by 1000 and rounded down, but does not explicitly mention that values less than 1000ms will result in 0 seconds. This can lead to confusion when users pass values like 400ms expecting sub-second keepalive delays. Add a concrete example showing that 400ms rounds down to 0 seconds. Refs: #57712 Signed-off-by: haramjeong <04harams77@gmail.com> PR-URL: #65869 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The current documentation states that
initialDelayandintervalare divided by 1000 and rounded down, but does not explicitly mention that values less than 1000ms will result in 0 seconds. This can lead to confusion when users pass values like 400ms expecting sub-second keepalive delays.This PR adds a concrete example showing that 400ms rounds down to 0 seconds.
Example
Refs
Checklist