Document require("stream/promises").pipeline end option
#48970
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
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.
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
aloisklink
changed the title
require("stream/promises").pipeline end option
lpinca
approved these changes
Jul 31, 2023
github-actions
bot
removed
the
request-ci
29 tasks
|
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) |
github-actions
bot
removed
the
request-ci
This was referenced Aug 27, 2023
lpinca
added
the
commit-queue-rebase
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.
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.