doc: correct Http2SecureServer.setTimeout() default - #65175
Closed
arhxam wants to merge 1 commit into
Closed
Conversation
The documented default for the `msecs` argument of `Http2SecureServer.setTimeout()` was `120000` (2 minutes), but the actual default timeout is `0` (no timeout): the constructor sets `this.timeout = 0` in lib/internal/http2/core.js, and the equivalent `Http2Server.setTimeout()` documentation already states `0 (no timeout)`. The default changed from 120s to 0 in nodejs#27558, but this line was missed when the sibling entries were updated. Correct the default and add the matching changelog entry. Signed-off-by: Arham Wani <arhamwani765@gmail.com>
Collaborator
|
Review requested:
|
nodejs-github-bot
added
doc
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.
Description
The documented default for the
msecsargument ofHttp2SecureServer.setTimeout()was120000(2 minutes), but theactual default timeout is
0(no timeout).Evidence:
The constructor sets
this.timeout = 0inlib/internal/http2/core.jsfor bothHttp2ServerandHttp2SecureServer.At runtime:
The equivalent
Http2Server.setTimeout()documentation alreadystates Default:
0 (no timeout)and carries av13.0.0changelog entry noting the default changed from 120s to 0 (in
http, http2: remove default server timeout #27558). The
Http2SecureServer.setTimeout()entry was missed in that update.This corrects the default to
0 (no timeout)and adds the matchingv13.0.0changelog entry so both server variants are consistent.Documentation-only change.