TS: fix definitions to have ReadableStream compatible with WebStream, add tests
#13
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
twiss
reviewed
Feb 28, 2022
web-stream-tools.d.ts
Outdated
|
|
||
| type Stream<T extends Data> = WebStream<T> | NodeStream<T>; | ||
| interface NodeStream<T extends Data> { // copied+simplified version of ReadableStream from @types/node/index.d.ts |
There was a problem hiding this comment.
Probably we should keep
Suggested change
| interface NodeStream<T extends Data> { // copied+simplified version of ReadableStream from @types/node/index.d.ts | |
| interface NodeStream<T extends Data> extends AsyncIterable<T> { // copied+simplified version of ReadableStream from @types/node/index.d.ts |
And also, just as a reminder, since we're removing AsyncIterable from WebStream (rightly so, as it isn't guaranteed to be there), we should update the examples in OpenPGP.js, as per openpgpjs/openpgpjs#1370.
twiss
approved these changes
Feb 28, 2022
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.
Changes:
WebStreamdefinition so that type inference works when using aReadableStream. Specifically, we cannot rely on theAsyncIterableinterface, because ReadableStreams are not currently implemented by all browsers as including the necessary properties.readToEnddefinition to supportjoinfunction with arbitrary output typePartially addresses #10 .