Commit 01a4104
doc: improve localWindowSize event descriptions
The documentation listed the wrong event to subscribe to when calling
`localWindowSize`. Also properly point out the correct event for http2
clients.
Fixes: #51014
Refs: #38426
PR-URL: #51071
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>1 parent 15731b4 commit 01a4104
1 file changed
Lines changed: 3 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -611,13 +611,15 @@ const http2 = require('node:http2'); | |||
| 611 | 611 | ||
| 612 | 612 | const server = http2.createServer(); | |
| 613 | 613 | const expectedWindowSize = 2 ** 20; | |
| 614 | - server.on('connect', (session) => { | ||
| 614 | + server.on('session', (session) => { | ||
| 615 | 615 | ||
| 616 | 616 | // Set local window size to be 2 ** 20 | |
| 617 | 617 | session.setLocalWindowSize(expectedWindowSize); | |
| 618 | 618 | }); | |
| 619 | 619 | ``` | |
| 620 | 620 | ||
| 621 | + For http2 clients the proper event is either `'connect'` or `'remoteSettings'`. | ||
| 622 | + | ||
| 621 | 623 | #### `http2session.setTimeout(msecs, callback)` | |
| 622 | 624 | ||
| 623 | 625 | <!-- YAML | |
0 commit comments