Skip to content

doc: document TransformStream transformer.cancel option #62566

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
TomStrepsil wants to merge 5 commits into
base: main
Choose a base branch
from
+11 −0
Open

doc: document TransformStream transformer.cancel option #62566

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ffa58ae
doc: document TransformStream transformer.cancel option
TomStrepsil Apr 2, 2026
183d8c2
doc: clarify writeable abort applies
TomStrepsil Apr 2, 2026
d74a0a7
add changelog
TomStrepsil Apr 2, 2026
7d8c0c7
doc: correct insertion of YAML comment
TomStrepsil Apr 2, 2026
868db31
doc: move comment to constructor
TomStrepsil Apr 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions doc/api/webstreams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1148,6 +1148,12 @@

<!-- YAML
added: v16.5.0
changes:
- version:
- v21.5.0
- v20.14.0
pr-url: https://github.com/nodejs/node/pull/50126

Check warning on line 1155 in doc/api/webstreams.md

View workflow job for this annotation

GitHub Actions / lint-pr-url 

pr-url doesn't match the URL of the current PR.
description: Supports the `cancel` transformer callback.
-->

* `transformer` {Object}
Expand All @@ -1166,6 +1172,11 @@
the transformation process.
* `controller` {TransformStreamDefaultController}
* Returns: A promise fulfilled with `undefined`.
* `cancel` {Function} A user-defined function that is called when either the
readable side of the `TransformStream` is canceled or the writable side is
aborted.
* `reason` {any}
* Returns: A promise fulfilled with `undefined`.
* `readableType` {any} the `readableType` option is reserved for future use
and _must_ be `undefined`.
* `writableType` {any} the `writableType` option is reserved for future use
Expand Down
Loading