Streams: fix closed getters #12750
Merged
Streams: fix closed getters #12750
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
sideshowbarker
approved these changes
Feb 6, 2022
|
Howdy Mattias — great to see you here. Thanks much for catching this and fixing it, and congrats on landing your first docs change here — welcome aboard 🎉 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 documentation for the
closedgetters ofReadableStreamBYOBReader,ReadableStreamDefaultReaderandWritableStreamDefaultWriterclaim that they resolve when the reader/writer's lock is released. In reality, they reject when the lock is released.Motivation
The current documentation is incorrect, and may give developers the wrong expectation when using these getters.
Supporting details
The official specification for
ReadableStreamDefaultReadersays:A similar wording can be found in the specification of
ReadableStreamBYOBReaderandWritableStreamDefaultWriter.Related issues
This was initially discovered in nodejs/node#41858 (comment), as Node's docs contain the same mistake.
The specification itself also had this mistake, but this was fixed in 2018: whatwg/streams#914. It's possible that the MDN docs were written using the (incorrect) specification from before that change.
Metadata