quic: add missing documentation for stream.stopSending() and stream.r…#63681
Open
vishalranaut wants to merge 1 commit into
Open
quic: add missing documentation for stream.stopSending() and stream.r…#63681vishalranaut wants to merge 1 commit into
vishalranaut wants to merge 1 commit into
Conversation
Collaborator
|
Review requested:
|
nodejs-github-bot
added
doc
Qard
approved these changes
May 31, 2026
atlowChemi
reviewed
May 31, 2026
| independent half-closing per direction without tearing down the entire | ||
| stream. | ||
|
|
||
| ```mjs |
Member
There was a problem hiding this comment.
Care to add a matching cjs code block?
| independent half-closing per direction without tearing down the entire | ||
| stream. | ||
|
|
||
| ```mjs |
| ### `stream.stopSending([code])` | ||
|
|
||
| <!-- YAML | ||
| added: REPLACEME |
Member
| ### `stream.resetStream([code])` | ||
|
|
||
| <!-- YAML | ||
| added: REPLACEME |
Member
There was a problem hiding this comment.
Seems to have already been released, I am not sure when though
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
quic: add missing documentation for
stream.stopSending()andstream.resetStream()Fixes #63680
What this PR does
Adds missing documentation for two
QuicStreammethods that are implemented in the source but not documented:stream.stopSending(code)— sends aSTOP_SENDINGframe to abort the readable side of the stream (half-close for incoming data)stream.resetStream(code)— sends aRESET_STREAMframe to abort the writable side of the stream (half-close for outgoing data)Both methods are important for protocols like WebTransport that require half-closing streams independently.
Why this matters
Without documentation, developers implementing WebTransport or other QUIC-based protocols had no way to discover or correctly use these methods from the official Node.js docs.
Changes made
stream.stopSending(code)entry todoc/api/quic.mdunder theQuicStreamclass sectionstream.resetStream(code)entry todoc/api/quic.mdunder theQuicStreamclass sectionFile changed:
doc/api/quic.mdChecklist
make lintpassesadded: REPLACEMEversion metadata as required for new doc entries