Skip to content

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

Rodrigo Muino Tomonari requested to merge github/fork/aloisklink/document-pipeline-end-option into main

Add documentation for the require("stream/promises").pipeline(...streams, {end: false}) option, that was added in https://github.com/nodejs/node/pull/40886.

The lacking documentation has been mentioned before (see https://github.com/nodejs/node/issues/34805#issuecomment-1345655205, and https://github.com/nodejs/node/issues/45821), but although https://github.com/nodejs/node/pull/45832 did document that the end option existed, it didn't document what the end option did.

I've also added a test to sanity check that setting end: false doesn't stop ending transform streams when calling pipeline(), since this behavior seems a bit unintuitive to me.

Merge request reports