diff options
| author | James M Snell <jasnell@gmail.com> | 2020-07-06 22:09:35 +0300 |
|---|---|---|
| committer | James M Snell <jasnell@gmail.com> | 2020-07-09 17:36:34 +0300 |
| commit | f98a441bf75f2b0b698a0f9dace218f56386ec4a (patch) | |
| tree | 6c35285473656b5523ec713ca922ac2bd37724c4 /doc/api/http2.md | |
| parent | a720c0edcc40a86bee9a696cd791df3420c398ad (diff) | |
doc: document the ready event for Http2Stream
Fixes: https://github.com/nodejs/node/issues/22804
PR-URL: https://github.com/nodejs/node/pull/34221
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'doc/api/http2.md')
| -rw-r--r-- | doc/api/http2.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/api/http2.md b/doc/api/http2.md index e17b65cf806..21ce7739fbf 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -984,6 +984,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 |