doc: improve doc Http2Stream: FrameError, Timeout and Trailers · nodejs/node@0022d75 · GitHub

nodejs / node Public

• Notifications You must be signed in to change notification settings
• Fork 36.6k
• Star 120k

• Code
• Issues 635
• Pull requests 754
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit 0022d75

Browse filesBrowse the repository at this point in the historyBrowse files

dev-script

authored and

targos

committed

doc: improve doc Http2Stream: FrameError, Timeout and Trailers

Document arguments for the 'frameError', 'timeout' and 'trailers' event. PR-URL: #30373 Fixes: nodejs/help#877 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

1 parent 5ae3a85 commit 0022d75
Copy full SHA for 0022d75

1 file changed

+9Lines changed: 9 additions & 0 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• doc/api
  • http2.md

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎doc/api/http2.md‎

Copy file name to clipboardExpand all lines: doc/api/http2.md

+9Lines changed: 9 additions & 0 deletions

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -970,6 +970,11 @@ an `Http2Stream`.
970	970	added: v8.4.0
971	971	-->
972	972
	973	+ * `type` {integer} The frame type.
	974	+ * `code` {integer} The error code.
	975	+ * `id` {integer} The stream id (or `0` if the frame isn't associated with a
	976	+ stream).
	977	+
973	978	The `'frameError'` event is emitted when an error occurs while attempting to
974	979	send a frame. When invoked, the handler function will receive an integer
975	980	argument identifying the frame type, and an integer argument identifying the
@@ -984,12 +989,16 @@ added: v8.4.0
984	989	The `'timeout'` event is emitted after no activity is received for this
985	990	`Http2Stream` within the number of milliseconds set using
986	991	`http2stream.setTimeout()`.
	992	+ Its listener does not expect any arguments.
987	993
988	994	#### Event: 'trailers'
989	995	<!-- YAML
990	996	added: v8.4.0
991	997	-->
992	998
	999	+ * `headers` {HTTP/2 Headers Object} An object describing the headers
	1000	+ * `flags` {number} The associated numeric flags
	1001	+
993	1002	The `'trailers'` event is emitted when a block of headers associated with
994	1003	trailing header fields is received. The listener callback is passed the
995	1004	[HTTP/2 Headers Object][] and flags associated with the headers.

0 commit comments

Comments

0 (0)