docs: update WebTransport unidirectional stream examples #37629
Merged
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
The WebTransport `createUnidirectionalStream` method returns a promise of a `WebTransportSendStream` (which extends `WritableStream`), not an object with a `.writable` property. So the developer can call `getWriter` directly on the resolved result of the promise instead of `.writable.getWriter` as with bidirectional streams. Refs: - [WebTransport.createUnidirectionalStream](https://www.w3.org/TR/webtransport/#dom-webtransport-createunidirectionalstream) - [WebTransportSendStream](https://www.w3.org/TR/webtransport/#webtransportsendstream)
achingbrain
requested review from
sideshowbarker
and removed request for
a team
github-actions
bot
added
Content:WebAPI
sideshowbarker
approved these changes
Jan 13, 2025
|
Alex, nice catch 〜 congrats on landing your first docs change here — welcome aboard 🎉 |
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.
Description
The WebTransport
createUnidirectionalStreammethod returns a promise of aWebTransportSendStream(which extendsWritableStream), not an object with a.writableproperty.So the developer can call
getWriterdirectly on the resolved result of the promise instead of.writable.getWriteras with bidirectional streams.Motivation
The examples are wrong.
Additional details