Skip to content

Commit f08650c

Browse files
Ayase-252targos
authored andcommittedApr 29, 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 2d59273 commit f08650c

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
@@ -1822,9 +1822,17 @@ an `Http2Session` object associated with the `Http2Server`.
18221822
added: v8.4.0
18231823
-->
18241824

1825+
* `stream` {Http2Stream} A reference to the stream
1826+
* `headers` {HTTP/2 Headers Object} An object describing the headers
1827+
* `flags` {number} The associated numeric flags
1828+
* `rawHeaders` {Array} An array containing the raw header names followed by
1829+
their respective values.
1830+
18251831
The `'stream'` event is emitted when a `'stream'` event has been emitted by
18261832
an `Http2Session` associated with the server.
18271833

1834+
See also [`Http2Session`'s `'stream'` event][].
1835+
18281836
```js
18291837
const http2 = require('http2');
18301838
const {
@@ -2010,9 +2018,17 @@ an `Http2Session` object associated with the `Http2SecureServer`.
20102018
added: v8.4.0
20112019
-->
20122020

2021+
* `stream` {Http2Stream} A reference to the stream
2022+
* `headers` {HTTP/2 Headers Object} An object describing the headers
2023+
* `flags` {number} The associated numeric flags
2024+
* `rawHeaders` {Array} An array containing the raw header names followed by
2025+
their respective values.
2026+
20132027
The `'stream'` event is emitted when a `'stream'` event has been emitted by
20142028
an `Http2Session` associated with the server.
20152029

2030+
See also [`Http2Session`'s `'stream'` event][].
2031+
20162032
```js
20172033
const http2 = require('http2');
20182034
const {
@@ -3845,6 +3861,7 @@ you need to implement any fall-back behaviour yourself.
38453861
[`Http2ServerRequest`]: #http2_class_http2_http2serverrequest
38463862
[`Http2ServerResponse`]: #http2_class_http2_http2serverresponse
38473863
[`Http2Session` and Sockets]: #http2_http2session_and_sockets
3864+
[`Http2Session`'s `'stream'` event]: #http2_event_stream
38483865
[`Http2Stream`]: #http2_class_http2stream
38493866
[`ServerHttp2Stream`]: #http2_class_serverhttp2stream
38503867
[`TypeError`]: errors.md#errors_class_typeerror

0 commit comments

Comments
 (0)
Please sign in to comment.