| 1 |
# merge-streams |
| 2 |
|
| 3 |
> Merge multiple streams into a unified stream |
| 4 |
|
| 5 |
## Install |
| 6 |
|
| 7 |
```sh |
| 8 |
npm install @sindresorhus/merge-streams |
| 9 |
``` |
| 10 |
|
| 11 |
## Usage |
| 12 |
|
| 13 |
```js |
| 14 |
import mergeStreams from '@sindresorhus/merge-streams'; |
| 15 |
|
| 16 |
const stream = mergeStreams([streamA, streamB]); |
| 17 |
|
| 18 |
for await (const chunk of stream) { |
| 19 |
console.log(chunk); |
| 20 |
//=> 'A1' |
| 21 |
//=> 'B1' |
| 22 |
//=> 'A2' |
| 23 |
//=> 'B2' |
| 24 |
} |
| 25 |
``` |
| 26 |
|
| 27 |
## API |
| 28 |
|
| 29 |
### `mergeStreams(streams: stream.Readable[]): MergedStream` |
| 30 |
|
| 31 |
Merges an array of [readable streams](https://nodejs.org/api/stream.html#readable-streams) and returns a new readable stream that emits data from the individual streams as it arrives. |
| 32 |
|
| 33 |
If you provide an empty array, the stream remains open but can be [manually ended](https://nodejs.org/api/stream.html#writableendchunk-encoding-callback). |
| 34 |
|
| 35 |
#### `MergedStream` |
| 36 |
|
| 37 |
_Type_: `stream.Readable` |
| 38 |
|
| 39 |
A single stream combining the output of multiple streams. |
| 40 |
|
| 41 |
##### `MergedStream.add(stream: stream.Readable): void` |
| 42 |
|
| 43 |
Pipe a new readable stream. |
| 44 |
|
| 45 |
Throws if `MergedStream` has already ended. |
| 46 |
|
| 47 |
##### `MergedStream.remove(stream: stream.Readable): Promise<boolean>` |
| 48 |
|
| 49 |
Unpipe a stream previously added using either [`mergeStreams(streams)`](#mergestreamsstreams-streamreadable-mergedstream) or [`MergedStream.add(stream)`](#mergedstreamaddstream-streamreadable-void). |
| 50 |
|
| 51 |
Returns `false` if the stream was not previously added, or if it was already removed by `MergedStream.remove(stream)`. |
| 52 |
|
| 53 |
The removed stream is not automatically ended. |