[v6] Drop support for native Node Readable stream: require passing Node Web Streams#1716
Merged
larabr merged 4 commits intoopenpgpjs:v6from Jan 26, 2024
Merged
[v6] Drop support for native Node Readable stream: require passing Node Web Streams#1716larabr merged 4 commits intoopenpgpjs:v6from
larabr merged 4 commits intoopenpgpjs:v6from
Conversation
6c19b8d to
f88a968
Compare
…b Streams Utils to convert from and to Web Streams in Node are available from v17, see https://nodejs.org/api/stream.html#streamreadabletowebstreamreadable-options . Previously, we automatically converted between Node native streams and custom, Web-like Readable streams. This led to occasional issues.
Avoid interfaces, since the original types are not interfaces either, and in TS v5 it could cause type inference issues between GenericWebStreams and the redefined WebStreams.
Move to away from Node native streams.
478d9e6 to
39cff85
Compare
1 task
twiss
approved these changes
Jan 26, 2024
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Breaking change: all functions taking streams as inputs will now require passing Web Streams in Node.js . If given a native
stream.Readableinput, they will throw. The browser build is unaffected by this change.More context about WebStream stream support in Node.js:
Node v16.5.0 adds supports for the Web Stream API, see https://nodejs.org/api/webstreams.html#web-streams-api .
Utils to convert from and to Web Streams in Node are available from v17,
see https://nodejs.org/api/stream.html#streamreadabletowebstreamreadable-options .
Previously, we automatically converted between Node native streams and custom, Web-like Readable streams.
This led to occasional issues (fix #1690).