Update Stream documentation #17506
Open
Update Stream documentation #17506
+7
−7
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
vicb
requested review from
irvinebroque,
jasnell,
mikenomitch,
GregBrimble and
a team
as code owners
vicb
commented
Oct 14, 2024
| @@ -15,7 +15,7 @@ The [Streams API](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API) | |||
|
|
|||
| <DirectoryListing /> | |||
|
|
|||
| Workers do not need to prepare an entire response body before delivering it to `event.respondWith()`. You can use [`TransformStream`](/workers/runtime-apis/streams/transformstream/) to stream a response body after sending the front matter (that is, HTTP status line and headers). This allows you to minimize: | |||
| Workers do not need to prepare an entire response body before returning a `Response`. You can use [`TransformStream`](/workers/runtime-apis/streams/transformstream/) to stream a response body after sending the front matter (that is, HTTP status line and headers). This allows you to minimize: | |||
There was a problem hiding this comment.
@irvinebroque Rereading that paragraph I think "You can use TransformStream" should actually be "You can use a ReadableStream"
Note that TransformStream implements ReadableStream so the current phrasing is not wrong, just a specialization of the generic case.
I can amend this PR or create a new one.
WDYT?
vicb
changed the title
- Use the module syntax over - TransformStream -> ReadableStream - let -> const where applicable
irvinebroque
approved these changes
Oct 14, 2024
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
Change
event.respondWith(...)forResponse.event.respondWith(...)is the old Service Worker API that is no more recommended.Note that the code snippet on this page is correctly using the Module Worker API.
reference: https://developers.cloudflare.com/workers/runtime-apis/fetch/
Documentation checklist