doc: clarify socket.setKeepAlive initialDelay arg#62171
Open
efekrskl wants to merge 2 commits intonodejs:mainfrom
Open
doc: clarify socket.setKeepAlive initialDelay arg#62171efekrskl wants to merge 2 commits intonodejs:mainfrom
efekrskl wants to merge 2 commits intonodejs:mainfrom
Conversation
Collaborator
|
Review requested:
|
nodejs-github-bot
added
doc
doc/api/net.md
Outdated
Comment on lines
+1405
to
+1407
| **Note:** Node.js converts `initialDelay` from milliseconds to seconds and truncates any fractional part. | ||
| For example, `1500` becomes `1`, and values from `1` to `999` become `0`. | ||
|
|
Member
There was a problem hiding this comment.
it might be helpful to also mention that values truncated to 0 will leave the delay unchanged, since that's the surprising part for users, for example setKeepAlive(true, 500) ends up not setting any delay at all
Contributor
Author
There was a problem hiding this comment.
Valid point, I've changed the examples to better clarify this behaviour, thanks!
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
3 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.
Closes #57712