Skip to content

Conversation

@anonhostpi
Copy link
Contributor

Update return value description to specify 'undefined' per #42173

Description

Current return type of reason is incorrect as indicated by testing in #42173. Updated to undefined

Motivation

Noticed the docs were wrong while trying to implement WritableStream.abort in my own code.

Additional details/related issues and pull requests

Fixes #42173

Update return value description to specify 'undefined' per mdn#42173
@anonhostpi anonhostpi requested a review from a team as a code owner November 30, 2025 21:01
@anonhostpi anonhostpi requested review from sideshowbarker and removed request for a team November 30, 2025 21:01
@github-actions github-actions bot added Content:WebAPI Web API docs size/xs [PR only] 0-5 LoC changed labels Nov 30, 2025
### Return value

A {{jsxref("Promise")}}, which fulfills with the value given in the `reason` parameter.
A {{jsxref("Promise")}}, which fulfills with `undefined` value.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator

@wbamberg wbamberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 thank you!

@github-actions
Copy link
Contributor

github-actions bot commented Dec 1, 2025

Preview URLs

Copy link
Collaborator

@wbamberg wbamberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 thank you!

@wbamberg wbamberg merged commit 6012fe9 into mdn:main Dec 1, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Content:WebAPI Web API docs size/xs [PR only] 0-5 LoC changed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

WritableStream.abort() has incorrect return type

2 participants