Skip to content

Commit 4bc87c1

Browse files
ryzokukenMylesBorins
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) PR-URL: #20371 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
1 parent 1908668 commit 4bc87c1

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
When using `http2session.settings()` to submit new settings, the modified
203204
settings do not take effect until the `'localSettings'` event is emitted.
@@ -215,9 +216,10 @@ session.on('localSettings', (settings) => {
215216
added: v8.4.0
216217
-->
217218

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

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

0 commit comments

Comments
 (0)