Skip to content

Commit

Permalink
doc: correct default values in http2 docs
Browse files Browse the repository at this point in the history
The http2 docs include invalid JavaScript values as defaults for three
options. The intention was increased clarity, but we specify valid
values everywhere else in our docs, so let's do that for consistency.

PR-URL: #33997
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
Trott authored and codebytere committed Jul 12, 2020
1 parent 498dfba commit 0693724
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions doc/api/http2.md
Original file line number Diff line number Diff line change
Expand Up @@ -2443,15 +2443,15 @@ properties.

* `headerTableSize` {number} Specifies the maximum number of bytes used for
header compression. The minimum allowed value is 0. The maximum allowed value
is 2<sup>32</sup>-1. **Default:** `4,096 octets`.
is 2<sup>32</sup>-1. **Default:** `4096`.
* `enablePush` {boolean} Specifies `true` if HTTP/2 Push Streams are to be
permitted on the `Http2Session` instances. **Default:** `true`.
* `initialWindowSize` {number} Specifies the *senders* initial window size
for stream-level flow control. The minimum allowed value is 0. The maximum
allowed value is 2<sup>32</sup>-1. **Default:** `65,535 bytes`.
* `maxFrameSize` {number} Specifies the size of the largest frame payload.
The minimum allowed value is 16,384. The maximum allowed value
is 2<sup>24</sup>-1. **Default:** `16,384 bytes`.
* `initialWindowSize` {number} Specifies the *sender's* initial window size in
bytes for stream-level flow control. The minimum allowed value is 0. The
maximum allowed value is 2<sup>32</sup>-1. **Default:** `65535`.
* `maxFrameSize` {number} Specifies the size in bytes of the largest frame
payload. The minimum allowed value is 16,384. The maximum allowed value is
2<sup>24</sup>-1. **Default:** `16384`.
* `maxConcurrentStreams` {number} Specifies the maximum number of concurrent
streams permitted on an `Http2Session`. There is no default value which
implies, at least theoretically, 2<sup>32</sup>-1 streams may be open
Expand Down

0 comments on commit 0693724

Please sign in to comment.