diff options
| author | Rich Trott <rtrott@gmail.com> | 2020-06-21 04:03:52 +0300 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2020-06-23 05:30:35 +0300 |
| commit | 86cbad837b3a0df8d291cde52a7a65c373e10707 (patch) | |
| tree | b981270f965e52097932d9efe8b2124f37d5e3f4 /doc/api/http2.md | |
| parent | db52ae8b7f9bc458b3ab47369fc828e273efd0df (diff) | |
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: https://github.com/nodejs/node/pull/33997
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/http2.md')
| -rw-r--r-- | doc/api/http2.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/api/http2.md b/doc/api/http2.md index f4399cd9116..3ad8b111672 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -2501,15 +2501,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 |