Skip to content

Commit 0693724

Browse files
Trottcodebytere
authored andcommitted
doc: correct default values in http2 docs
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 <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 498dfba commit 0693724

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

doc/api/http2.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -2443,15 +2443,15 @@ properties.
24432443

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

0 commit comments

Comments
 (0)