Add support for ReadableStream
#82
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
sindresorhus
requested changes
Aug 9, 2023
| ```js | ||
| const {body: readableStream} = await fetch('https://example.com'); | ||
| console.log(await getStream(readableStream)); | ||
| ``` |
There was a problem hiding this comment.
Can you add this to the TS docs too?
There was a problem hiding this comment.
Fixed in 80ac07e. 👍
index.d.ts
Outdated
| @@ -6,6 +6,9 @@ export class MaxBufferError extends Error { | |||
| constructor(); | |||
| } | |||
|
|
|||
| type StreamItem = string | Buffer | ArrayBuffer | ArrayBufferView; | |||
| type AnyStream = Readable | ReadableStream<StreamItem> | AsyncIterable<StreamItem>; | |||
There was a problem hiding this comment.
I would export this, in case the user needs to refer to the input without passing it directly.
There was a problem hiding this comment.
Fixed in 6990861. 👍
This was referenced Aug 13, 2023
Closed
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.
This adds support for web/Node.js
ReadableStreams.This also adds support for any async iterable as input, since this is the common denominator between Node.js streams and web
ReadableStream(which we just consume with afor awaitloop).