Skip to content

Commit 448922d

Browse files
ryzokukenBethGriggs
authored andcommitted
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) Backport-PR-URL: #22850 PR-URL: #20547 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
1 parent 395ce84 commit 448922d

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

doc/api/http2.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -233,10 +233,13 @@ session.on('remoteSettings', (settings) => {
233233
added: v8.4.0
234234
-->
235235

236-
The `'stream'` event is emitted when a new `Http2Stream` is created. When
237-
invoked, the handler function will receive a reference to the `Http2Stream`
238-
object, a [HTTP/2 Headers Object][], and numeric flags associated with the
239-
creation of the stream.
236+
* `stream` {Http2Stream} A reference to the stream
237+
* `headers` {HTTP/2 Headers Object} An object describing the headers
238+
* `flags` {number} The associated numeric flags
239+
* `rawHeaders` {Array} An array containing the raw header names followed by
240+
their respective values.
241+
242+
The `'stream'` event is emitted when a new `Http2Stream` is created.
240243

241244
```js
242245
const http2 = require('http2');

0 commit comments

Comments
 (0)