Skip to content

Commit a75b7af

Browse files
Ayase-252targos
authored andcommittedJun 11, 2021
doc: add arguments for stream event of Http2Server and Http2SecureServer
PR-URL: #37892 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent cf0007e commit a75b7af

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed
 

‎doc/api/http2.md

+17
Original file line numberDiff line numberDiff line change
@@ -1789,9 +1789,17 @@ an `Http2Session` object associated with the `Http2Server`.
17891789
added: v8.4.0
17901790
-->
17911791

1792+
* `stream` {Http2Stream} A reference to the stream
1793+
* `headers` {HTTP/2 Headers Object} An object describing the headers
1794+
* `flags` {number} The associated numeric flags
1795+
* `rawHeaders` {Array} An array containing the raw header names followed by
1796+
their respective values.
1797+
17921798
The `'stream'` event is emitted when a `'stream'` event has been emitted by
17931799
an `Http2Session` associated with the server.
17941800

1801+
See also [`Http2Session`'s `'stream'` event][].
1802+
17951803
```js
17961804
const http2 = require('http2');
17971805
const {
@@ -1977,9 +1985,17 @@ an `Http2Session` object associated with the `Http2SecureServer`.
19771985
added: v8.4.0
19781986
-->
19791987

1988+
* `stream` {Http2Stream} A reference to the stream
1989+
* `headers` {HTTP/2 Headers Object} An object describing the headers
1990+
* `flags` {number} The associated numeric flags
1991+
* `rawHeaders` {Array} An array containing the raw header names followed by
1992+
their respective values.
1993+
19801994
The `'stream'` event is emitted when a `'stream'` event has been emitted by
19811995
an `Http2Session` associated with the server.
19821996

1997+
See also [`Http2Session`'s `'stream'` event][].
1998+
19831999
```js
19842000
const http2 = require('http2');
19852001
const {
@@ -3739,6 +3755,7 @@ following additional properties:
37393755
[`Http2ServerRequest`]: #http2_class_http2_http2serverrequest
37403756
[`Http2ServerResponse`]: #http2_class_http2_http2serverresponse
37413757
[`Http2Session` and Sockets]: #http2_http2session_and_sockets
3758+
[`Http2Session`'s `'stream'` event]: #http2_event_stream
37423759
[`Http2Stream`]: #http2_class_http2stream
37433760
[`ServerHttp2Stream`]: #http2_class_serverhttp2stream
37443761
[`TypeError`]: errors.md#errors_class_typeerror

0 commit comments

Comments
 (0)
Please sign in to comment.