Permalink
Browse files

doc: improve docs for Http2Session:frameError

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: nodejs/help#877 (comment)

PR-URL: #20236
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
  • Loading branch information...
ryzokuken committed Apr 23, 2018
1 parent 1e40b75 commit 2a30bfe295eadbdaea3675447b9fe743c622b47b
Showing with 5 additions and 7 deletions.
  1. +5 −7 doc/api/http2.md
@@ -159,18 +159,16 @@ an `Http2Session`.
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
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
`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
closed and destroyed immediately following the `'frameError'` event. If the
event is not associated with a stream, the `Http2Session` will be shut down

0 comments on commit 2a30bfe

Please sign in to comment.