1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: improve docs for Http2Session:frameError

Browse Source 
Improve documentation regarding the callback parameters for the
frameError event for instances of Http2Session, making it inline with
the currently accepted structure, like the rest of the documentation.

Refs: https://github.com/nodejs/help/issues/877#issuecomment-381253464

PR-URL: https://github.com/nodejs/node/pull/20236
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
This commit is contained in:
Ujjwal Sharma 2018-04-24 02:47:21 +05:30
parent 1e40b75404
commit 2a30bfe295
No known key found for this signature in database
GPG Key ID: 1FD3B47B83F46621
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/api/http2.md
View File

@ -159,18 +159,16 @@ an `Http2Session`.
added: v8.4.0 added: v8.4.0
--> -->
* `type` {integer} The frame type.
* `code` {integer} The error code.
* `id` {integer} The stream id (or `0` if the frame isn't associated with a
stream).
The `'frameError'` event is emitted when an error occurs while attempting to The `'frameError'` event is emitted when an error occurs while attempting to
send a frame on the session. If the frame that could not be sent is associated send a frame on the session. If the frame that could not be sent is associated
with a specific `Http2Stream`, an attempt to emit `'frameError'` event on the with a specific `Http2Stream`, an attempt to emit `'frameError'` event on the
`Http2Stream` is made. `Http2Stream` is made.
When invoked, the handler function will receive three arguments:
* An integer identifying the frame type.
* An integer identifying the error code.
* An integer identifying the stream (or 0 if the frame is not associated with
a stream).
If the `'frameError'` event is associated with a stream, the stream will be If the `'frameError'` event is associated with a stream, the stream will be
closed and destroyed immediately following the `'frameError'` event. If the closed and destroyed immediately following the `'frameError'` event. If the
event is not associated with a stream, the `Http2Session` will be shut down event is not associated with a stream, the `Http2Session` will be shut down