| 1 |
import {type Readable} from 'node:stream'; |
| 2 |
|
| 3 |
/** |
| 4 |
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. |
| 5 |
|
| 6 |
If you provide an empty array, the stream remains open but can be [manually ended](https://nodejs.org/api/stream.html#writableendchunk-encoding-callback). |
| 7 |
|
| 8 |
@example |
| 9 |
``` |
| 10 |
import mergeStreams from '@sindresorhus/merge-streams'; |
| 11 |
|
| 12 |
const stream = mergeStreams([streamA, streamB]); |
| 13 |
|
| 14 |
for await (const chunk of stream) { |
| 15 |
console.log(chunk); |
| 16 |
//=> 'A1' |
| 17 |
//=> 'B1' |
| 18 |
//=> 'A2' |
| 19 |
//=> 'B2' |
| 20 |
} |
| 21 |
``` |
| 22 |
*/ |
| 23 |
export default function mergeStreams(streams: Readable[]): MergedStream; |
| 24 |
|
| 25 |
/** |
| 26 |
A single stream combining the output of multiple streams. |
| 27 |
*/ |
| 28 |
export class MergedStream extends Readable { |
| 29 |
/** |
| 30 |
Pipe a new readable stream. |
| 31 |
|
| 32 |
Throws if `MergedStream` has already ended. |
| 33 |
*/ |
| 34 |
add(stream: Readable): void; |
| 35 |
|
| 36 |
/** |
| 37 |
Unpipe a stream previously added using either `mergeStreams(streams)` or `MergedStream.add(stream)`. |
| 38 |
|
| 39 |
Returns `false` if the stream was not previously added, or if it was already removed by `MergedStream.remove(stream)`. |
| 40 |
|
| 41 |
The removed stream is not automatically ended. |
| 42 |
*/ |
| 43 |
remove(stream: Readable): Promise<boolean>; |
| 44 |
} |