Uh oh!
There was an error while loading. Please reload this page.
Document require("stream/promises").pipelineend option - #48970
Merged
Conversation
require("stream/promises").pipelineend optionlpinca
approved these changes
Jul 31, 2023
aloisklink
commented
Aug 1, 2023
ContributorAuthor
nodejs-github-bot
commented
Aug 10, 2023
Collaborator
29 tasks
ContributorAuthor
CI seems to have failed due to a It sounds like this is just a random error unrelated to this PR due to a CI worker dying/losing connection. Can a maintainer re-add a request-ci label? Edit: It may also be worth labeling this PR as doc (and maybe test too) |
nodejs-github-bot
commented
Aug 26, 2023
Collaborator
This was referenced Aug 27, 2023
nodejs-github-bot
commented
Sep 7, 2023
Collaborator
aduh95force-pushed
the
document-pipeline-end-option
branch
from
May 11, 2024 14:15
7a279a1 to
7ea65beComparenodejs-github-bot
commented
May 11, 2024
Collaborator
nodejs-github-bot
commented
May 12, 2024
Collaborator
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>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>
aduh95force-pushed
the
document-pipeline-end-option
branch
from
May 12, 2024 09:19
7ea65be to
ca2f874Compareaduh95
commented
May 12, 2024
Contributor
Landed in 1223294...ca2f874 |
targos pushed a commit
that referenced
this pull request
May 12, 2024
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: #48970
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>targos pushed a commit
that referenced
this pull request
May 12, 2024
There is currently no documentation about what the `end` option in `stream.promises.pipeline` does. Refs: #40886 Refs: #34805 (comment)Fixes: #45821 PR-URL: #48970 Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Merged
marco-ippolito pushed a commit
that referenced
this pull request
Jun 17, 2024
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: #48970
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>marco-ippolito pushed a commit
that referenced
this pull request
Jun 17, 2024
There is currently no documentation about what the `end` option in `stream.promises.pipeline` does. Refs: #40886 Refs: #34805 (comment)Fixes: #45821 PR-URL: #48970 Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
eliphazbouye pushed a commit
to eliphazbouye/node
that referenced
this pull request
Jun 20, 2024
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>eliphazbouye pushed a commit
to eliphazbouye/node
that referenced
this pull request
Jun 20, 2024
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>
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 freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
Add documentation for the
require("stream/promises").pipeline(...streams, {end: false})option, that was added in #40886.The lacking documentation has been mentioned before (see #34805 (comment), and #45821), but although #45832 did document that the
endoption existed, it didn't document what theendoption did.I've also added a test to sanity check that setting
end: falsedoesn't stop endingtransformstreams when callingpipeline(), since this behavior seems a bit unintuitive to me.