doc: document pipeline with end
option
There is currently no documentation about what the `end` option in `stream.promises.pipeline` does. Refs: https://github.com/nodejs/node/pull/40886 Refs: https://github.com/nodejs/node/issues/34805#issuecomment-1345655205 Fixes: https://github.com/nodejs/node/issues/45821 PR-URL: https://github.com/nodejs/node/pull/48970 Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
This commit is contained in:
parent
f3f1aec096
commit
ca2f874fe3
@ -65,6 +65,15 @@ or `require('node:stream').promises`.
|
||||
|
||||
<!-- YAML
|
||||
added: v15.0.0
|
||||
changes:
|
||||
- version:
|
||||
- v18.0.0
|
||||
- v17.2.0
|
||||
- v16.14.0
|
||||
pr-url: https://github.com/nodejs/node/pull/40886
|
||||
description: Add the `end` option, which can be set to `false` to prevent
|
||||
automatically closing the destination stream when the source
|
||||
ends.
|
||||
-->
|
||||
|
||||
* `streams` {Stream\[]|Iterable\[]|AsyncIterable\[]|Function\[]}
|
||||
@ -76,9 +85,11 @@ added: v15.0.0
|
||||
* `destination` {Stream|Function}
|
||||
* `source` {AsyncIterable}
|
||||
* Returns: {Promise|AsyncIterable}
|
||||
* `options` {Object}
|
||||
* `options` {Object} Pipeline options
|
||||
* `signal` {AbortSignal}
|
||||
* `end` {boolean}
|
||||
* `end` {boolean} End the destination stream when the source stream ends.
|
||||
Transform streams are always ended, even if this value is `false`.
|
||||
**Default:** `true`.
|
||||
* Returns: {Promise} Fulfills when the pipeline is complete.
|
||||
|
||||
```cjs
|
||||
|
Loading…
x
Reference in New Issue
Block a user