Add transformer.cancel method to TransformStream constructor
#25519
Conversation
This file contains 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
github-actions
bot
added
data:api
caugner
requested changes
Jan 2, 2025
api/TransformStream.json
Outdated
Comment on lines
91
to
93
| "cancel": { | ||
| "__compat": { | ||
| "description": "`transformer.cancel` method", |
There was a problem hiding this comment.
Given that cancel is the key in the parameter object passed to the TransformStream constructor, it confuses me slightly that this is called a method (even if the spec uses this terminology). How about:
Suggested change
| "cancel": { | |
| "__compat": { | |
| "description": "`transformer.cancel` method", | |
| "transformer_cancel_callback": { | |
| "__compat": { | |
| "description": "`transformer.cancel` callback", |
There was a problem hiding this comment.
The MDN articles for the ReadableStream/WritableStream/TransformStream constructors as well as the streams guides also talk about "methods", so I tried to be consistent with those. Although the specification does use the name TransformerCancelCallback for the type of that method... 😅
I think I'll stick with "method" for now. I'll make the feature name a bit more specific though, like you suggested.
Merged
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.
Summary
The transformer object passed to the
TransformStreamconstructor can now also have acancelmethod, which is called whenever the readable side is cancelled or when the writable side is aborted. See the specification and the spec change for context.Test results and supporting details
This method is not yet supported in any browser. However, server runtimes such as Node.js and Deno already support it: