diff options
| author | James M Snell <jasnell@gmail.com> | 2020-07-11 02:56:22 +0300 |
|---|---|---|
| committer | James M Snell <jasnell@gmail.com> | 2020-07-16 03:17:01 +0300 |
| commit | 57c1129508092d50ff12759360f85ff681d83574 (patch) | |
| tree | 5963b5a15a1835e31e69077a63936875c575807b /doc/api/quic.md | |
| parent | 8e5c5b16ab3764958f4fd5d9518814a375e6d071 (diff) | |
quic: implement QuicSession close as promise
PR-URL: https://github.com/nodejs/node/pull/34283
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Diffstat (limited to 'doc/api/quic.md')
| -rw-r--r-- | doc/api/quic.md | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/doc/api/quic.md b/doc/api/quic.md index d362e55328b..56dc1f2bff9 100644 --- a/doc/api/quic.md +++ b/doc/api/quic.md @@ -352,7 +352,7 @@ Binds the `QuicEndpoint` if it has not already been bound. User code will not typically be responsible for binding a `QuicEndpoint` as the owning `QuicSocket` will do that automatically. -* `options` {object} +* `options` {Object} * `signal` {AbortSignal} Optionally allows the `bind()` to be canceled using an `AbortController`. * Returns: {Promise} @@ -821,17 +821,16 @@ added: REPLACEME Information about the cipher algorithm selected for the session. -#### quicsession.close(\[callback\]) +#### quicsession.close() <!-- YAML added: REPLACEME --> -* `callback` {Function} Callback invoked when the close operation is completed - Begins a graceful close of the `QuicSession`. Existing `QuicStream` instances will be permitted to close naturally. New `QuicStream` instances will not be permitted. Once all `QuicStream` instances have closed, the `QuicSession` -instance will be destroyed. +instance will be destroyed. Returns a `Promise` that is resolved once the +`QuicSession` instance is destroyed. #### quicsession.closeCode <!-- YAML |