Skip to content

Commit 41e8931

Browse files
ryzokukenBethGriggs
authored andcommitted
doc: add parameters for settings events
Add parameters for the callback for the Http2Session:localSettings event and Http2Session:remoteSettings event inline with the pattern in the rest of the documentation. Refs: nodejs/help#877 (comment) Backport-PR-URL: #22850 PR-URL: #20371 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
1 parent aa341d1 commit 41e8931

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

doc/api/http2.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -195,9 +195,10 @@ event is emitted.
195195
added: v8.4.0
196196
-->
197197

198+
* `settings` {HTTP/2 Settings Object} A copy of the `SETTINGS` frame received.
199+
198200
The `'localSettings'` event is emitted when an acknowledgment `SETTINGS` frame
199-
has been received. When invoked, the handler function will receive a copy of
200-
the local settings.
201+
has been received.
201202

202203
*Note*: When using `http2session.settings()` to submit new settings, the
203204
modified settings do not take effect until the `'localSettings'` event is
@@ -216,9 +217,10 @@ session.on('localSettings', (settings) => {
216217
added: v8.4.0
217218
-->
218219

220+
* `settings` {HTTP/2 Settings Object} A copy of the `SETTINGS` frame received.
221+
219222
The `'remoteSettings'` event is emitted when a new `SETTINGS` frame is received
220-
from the connected peer. When invoked, the handler function will receive a copy
221-
of the remote settings.
223+
from the connected peer.
222224

223225
```js
224226
session.on('remoteSettings', (settings) => {

0 commit comments

Comments
 (0)