UNPKG

1.38 kBMarkdownView Raw
1# Installation
2> `npm install --save @types/merge-stream`
3
4# Summary
5This package contains type definitions for merge-stream (https://github.com/grncdr/merge-stream).
6
7# Details
8Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/merge-stream.
9## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/merge-stream/index.d.ts)
10````ts
11/// <reference types="node"/>
12
13interface MergedStream extends NodeJS.ReadWriteStream {
14 /**
15 * A method to dynamically add more sources to the stream. The argument supplied to add can be
16 * either a source or an array of sources.
17 */
18 add(source: NodeJS.ReadableStream | readonly NodeJS.ReadableStream[]): MergedStream;
19
20 /**
21 * A method that tells you if the merged stream is empty.
22 */
23 isEmpty(): boolean;
24}
25
26declare function merge<T extends NodeJS.ReadableStream>(...streams: Array<T | readonly T[]>): MergedStream;
27export = merge;
28
29````
30
31### Additional Details
32 * Last updated: Fri, 27 Sep 2024 16:40:34 GMT
33 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)
34
35# Credits
36These definitions were written by [Keita Kagurazaka](https://github.com/k-kagurazaka), [Tom X. Tobin](https://github.com/tomxtobin), [Daniel Zazula](https://github.com/daniel-zazula), and [Daniel Cassidy](https://github.com/djcsdy).
37
\No newline at end of file