diff --git a/doc/api/http2.md b/doc/api/http2.md index f5dbe67fc514..b7fee4396ca5 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -669,10 +669,16 @@ added: * `windowSize` {number} -Sets the local endpoint's window size. +Sets the local endpoint's connection-level window size. The `windowSize` is the total window size to set, not the delta. +Increases take effect immediately, but decreases only apply as the window +already advertised to the peer is consumed, since a window that has been +advertised cannot be retracted. To use a window smaller than the default from +the start of the connection, set the `connectionWindowSize` option when +creating the server or client session instead. + ```mjs import { createServer } from 'node:http2'; @@ -2844,6 +2850,9 @@ Throws `ERR_INVALID_ARG_TYPE` for invalid `settings` argument.