mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-08-12 13:00:19 +00:00
Added comments to the functions
This commit is contained in:
Vendored
+15
@@ -11,9 +11,24 @@ import {DuplexOptions} from 'stream';
|
||||
type StreamType = NodeJS.ReadableStream | IMerge2Stream;
|
||||
|
||||
interface IMerge2Stream extends NodeJS.ReadWriteStream {
|
||||
/**
|
||||
* @brief Add more streams to an existing merged stream
|
||||
*
|
||||
* @param args streams to add
|
||||
*
|
||||
* @return The merged stream
|
||||
*/
|
||||
add(...args: Array<StreamType | Array<StreamType>>): IMerge2Stream;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief This function takes an arbitrary number of streams, but the duplexoption
|
||||
* has to be the last parameter of the function.
|
||||
*
|
||||
* @param args The arguments
|
||||
*
|
||||
* @return A merged duplex stream
|
||||
*/
|
||||
declare function IMerge2 (...args: Array<StreamType | Array<StreamType> | DuplexOptions>): IMerge2Stream;
|
||||
|
||||
declare namespace IMerge2 {}
|
||||
|
||||
Reference in New Issue
Block a user