Commit 252ca72
doc: add parameters for Http2Session:stream event
Add parameters for the callback for the Http2Session:stream event
inline with the pattern in the rest of the documentation.
Refs: nodejs/help#877 (comment)
PR-URL: #20547
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>1 parent daa0940 commit 252ca72
1 file changed
Lines changed: 7 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -232,10 +232,13 @@ session.on('remoteSettings', (settings) => { | |||
| 232 | 232 | added: v8.4.0 | |
| 233 | 233 | --> | |
| 234 | 234 | ||
| 235 | - The `'stream'` event is emitted when a new `Http2Stream` is created. When | ||
| 236 | - invoked, the handler function will receive a reference to the `Http2Stream` | ||
| 237 | - object, a [HTTP/2 Headers Object][], and numeric flags associated with the | ||
| 238 | - creation of the stream. | ||
| 235 | + * `stream` {Http2Stream} A reference to the stream | ||
| 236 | + * `headers` {HTTP/2 Headers Object} An object describing the headers | ||
| 237 | + * `flags` {number} The associated numeric flags | ||
| 238 | + * `rawHeaders` {Array} An array containing the raw header names followed by | ||
| 239 | + their respective values. | ||
| 240 | + | ||
| 241 | + The `'stream'` event is emitted when a new `Http2Stream` is created. | ||
| 239 | 242 | ||
| 240 | 243 | ```js | |
| 241 | 244 | const http2 = require('http2'); | |
0 commit comments