From a75b7af9bd3b5259b6c0cf7e4e717c1a2e5c7f55 Mon Sep 17 00:00:00 2001 From: Qingyu Deng Date: Wed, 24 Mar 2021 23:38:10 +0800 Subject: [PATCH] doc: add arguments for stream event of Http2Server and Http2SecureServer PR-URL: https://github.com/nodejs/node/pull/37892 Reviewed-By: Luigi Pinca Reviewed-By: James M Snell --- doc/api/http2.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/doc/api/http2.md b/doc/api/http2.md index fd83a711313c8e..e523bc13f20ea6 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -1789,9 +1789,17 @@ an `Http2Session` object associated with the `Http2Server`. added: v8.4.0 --> +* `stream` {Http2Stream} A reference to the stream +* `headers` {HTTP/2 Headers Object} An object describing the headers +* `flags` {number} The associated numeric flags +* `rawHeaders` {Array} An array containing the raw header names followed by + their respective values. + The `'stream'` event is emitted when a `'stream'` event has been emitted by an `Http2Session` associated with the server. +See also [`Http2Session`'s `'stream'` event][]. + ```js const http2 = require('http2'); const { @@ -1977,9 +1985,17 @@ an `Http2Session` object associated with the `Http2SecureServer`. added: v8.4.0 --> +* `stream` {Http2Stream} A reference to the stream +* `headers` {HTTP/2 Headers Object} An object describing the headers +* `flags` {number} The associated numeric flags +* `rawHeaders` {Array} An array containing the raw header names followed by + their respective values. + The `'stream'` event is emitted when a `'stream'` event has been emitted by an `Http2Session` associated with the server. +See also [`Http2Session`'s `'stream'` event][]. + ```js const http2 = require('http2'); const { @@ -3739,6 +3755,7 @@ following additional properties: [`Http2ServerRequest`]: #http2_class_http2_http2serverrequest [`Http2ServerResponse`]: #http2_class_http2_http2serverresponse [`Http2Session` and Sockets]: #http2_http2session_and_sockets +[`Http2Session`'s `'stream'` event]: #http2_event_stream [`Http2Stream`]: #http2_class_http2stream [`ServerHttp2Stream`]: #http2_class_serverhttp2stream [`TypeError`]: errors.md#errors_class_typeerror