Skip to content

Commit

Permalink
doc: document the ready event for Http2Stream
Browse files Browse the repository at this point in the history
Fixes: #22804

PR-URL: #34221
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
  • Loading branch information
jasnell authored and addaleax committed Sep 22, 2020
1 parent fbb36ed commit 2615e55
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions doc/api/http2.md
Original file line number Diff line number Diff line change
Expand Up @@ -983,6 +983,15 @@ argument identifying the frame type, and an integer argument identifying the
error code. The `Http2Stream` instance will be destroyed immediately after the
`'frameError'` event is emitted.

#### Event: `'ready'`
<!-- YAML
added: v8.4.0
-->

The `'ready'` event is emitted when the `Http2Stream` has been opened, has
been assigned an `id`, and can be used. The listener does not expect any
arguments.

#### Event: `'timeout'`
<!-- YAML
added: v8.4.0
Expand Down

0 comments on commit 2615e55

Please sign in to comment.