doc: document TransformStream transformer.cancel option#62566
Open
TomStrepsil wants to merge 5 commits intonodejs:mainfrom
Open
doc: document TransformStream transformer.cancel option#62566TomStrepsil wants to merge 5 commits intonodejs:mainfrom
TomStrepsil wants to merge 5 commits intonodejs:mainfrom
Conversation
Add documentation for the `cancel` option of the `TransformStream` transformer, which allows users to specify a callback that will be called when the stream is canceled. See: https://streams.spec.whatwg.org/#transformer-api Fixes: nodejs#62540
There was a problem hiding this comment.
Pull request overview
Adds missing documentation for the TransformStream transformer’s cancel callback, aligning Node’s Web Streams docs with the WHATWG Streams standard and addressing #62540.
Changes:
- Document the
transformer.canceloption fornew TransformStream(). - Describe the callback’s invocation timing (readable-side cancellation), its
reasonparameter, and return value.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Renegade334
reviewed
Apr 2, 2026
Renegade334
reviewed
Apr 2, 2026
Update to the documentation to confirm that 6.2.3 of the standard states: "A function called when the readable side is cancelled, or when the writable side is aborted."
Renegade334
added
author ready
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
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.
Add documentation for the
canceloption of theTransformStreamtransformer, which allows users to specify a callback that will be called when the stream is canceled.See: https://streams.spec.whatwg.org/#transformer-api
Fixes: #62540