Skip to content

Commit 525f369

Browse files
committed
chore: add docs
Signed-off-by: Pablo Eliseo <[email protected]>
1 parent 82e71b9 commit 525f369

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docs/docs/api/Client.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ Returns: `Client`
3232
* **allowH2**: `boolean` - Default: `false`. Enables support for H2 if the server has assigned bigger priority to it through ALPN negotiation.
3333
* **useH2c**: `boolean` - Default: `false`. Enforces h2c for non-https connections.
3434
* **maxConcurrentStreams**: `number` - Default: `100`. Dictates the maximum number of concurrent streams for a single H2 session. It can be overridden by a SETTINGS remote frame.
35+
* **http2**: `object` (optional) - HTTP/2 session options.
36+
* **initialWindowSize**: `number` (optional) - Sets the HTTP/2 stream-level flow-control window size (SETTINGS_INITIAL_WINDOW_SIZE). Must be a positive integer greater than 0. See [RFC 7540 Section 6.9.2](https://datatracker.ietf.org/doc/html/rfc7540#section-6.9.2) for more details.
37+
* **connectionWindowSize**: `number` (optional) - Sets the HTTP/2 connection-level flow-control window size using `ClientHttp2Session.setLocalWindowSize()`. Must be a positive integer greater than 0. This controls the total amount of data that can be sent on the connection before receiving flow control updates from the peer. See [Node.js HTTP/2 documentation](https://nodejs.org/api/http2.html#clienthttp2sessionsetlocalwindowsize) for more details.
3538

3639
> **Notes about HTTP/2**
3740
> - It only works under TLS connections. h2c is not supported.

0 commit comments

Comments
 (0)