Commit 4bc87c1
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 <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>1 parent 1908668 commit 4bc87c1
1 file changed
Lines changed: 6 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -195,9 +195,10 @@ event is emitted. | |||
| 195 | 195 | added: v8.4.0 | |
| 196 | 196 | --> | |
| 197 | 197 | ||
| 198 | + * `settings` {HTTP/2 Settings Object} A copy of the `SETTINGS` frame received. | ||
| 199 | + | ||
| 198 | 200 | 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. | ||
| 201 | 202 | ||
| 202 | 203 | When using `http2session.settings()` to submit new settings, the modified | |
| 203 | 204 | settings do not take effect until the `'localSettings'` event is emitted. | |
@@ -215,9 +216,10 @@ session.on('localSettings', (settings) => { | |||
| 215 | 216 | added: v8.4.0 | |
| 216 | 217 | --> | |
| 217 | 218 | ||
| 219 | + * `settings` {HTTP/2 Settings Object} A copy of the `SETTINGS` frame received. | ||
| 220 | + | ||
| 218 | 221 | 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. | ||
| 221 | 223 | ||
| 222 | 224 | ```js | |
| 223 | 225 | session.on('remoteSettings', (settings) => { | |
0 commit comments