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