Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document require("stream/promises").pipeline end option #48970

Merged
merged 2 commits into from
May 12, 2024
Merged

Document require("stream/promises").pipeline end option #48970

merged 2 commits into from
May 12, 2024
+18 −3

Commits on May 12, 2024

  1. test: test pipeline end on transform streams 

    Add test that confirms that
`stream.promises.pipeline(source, transform, dest, {end: false});`
only skips ending the destination stream.
`{end: false}` should still end any transform streams.

PR-URL: nodejs#48970
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
    @aloisklink @aduh95
    aloisklink authored and aduh95 committed May 12, 2024
    Configuration menu
    Copy the full SHA
    f3f1aec View commit details
    Browse the repository at this point in the history

  2. doc: document pipeline with end option 

    There is currently no documentation about what the `end` option in
`stream.promises.pipeline` does.

Refs: nodejs#40886
Refs: nodejs#34805 (comment)
Fixes: nodejs#45821
PR-URL: nodejs#48970
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
    @aloisklink @aduh95
    aloisklink authored and aduh95 committed May 12, 2024
    Configuration menu
    Copy the full SHA
    ca2f874 View commit details
    Browse the repository at this point in the history