Skip to content

Latest commit

 

History

History
97 lines (69 loc) · 2.96 KB

API.md

File metadata and controls

97 lines (69 loc) · 2.96 KB

API

Classes

StreamQueue

Pipe queued streams sequentially

Functions

queueObjectStreams(options, ...streams) ⇒

Create a new queue in object mode and pipe given streams and end if some

queueStreams(options, ...streams) ⇒

Create a new queue and pipe given streams and end if some

StreamQueue

Pipe queued streams sequentially

Kind: global class

new StreamQueue(options, ...streams)

Create a new queue and pipe given streams and end if some

Returns: StreamQueue

Param Type Description
options Object The queue options
options.objectMode boolean Operate in object mode
options.pauseFlowingStream boolean Pause given streams that are flowing
options.resumeFlowingStream boolean Resume given streams that are flowing
...streams Readable | function The stream or stream returning function to pipe in

streamQueue.queue(...streams) ⇒

Queue each stream given in argument

Kind: instance method of StreamQueue
Returns: StreamQueue

Param Type Description
...streams Readable | function The stream or stream returning function to pipe in

streamQueue.done(...streams) ⇒

Queue each stream given in argument and end

Kind: instance method of StreamQueue
Returns: StreamQueue

Param Type Description
...streams Readable | function The stream or stream returning function to pipe in

queueObjectStreams(options, ...streams) ⇒

Create a new queue in object mode and pipe given streams and end if some

Kind: global function
Returns: StreamQueue

Param Type Description
options Object The queue options
...streams Readable | function The stream or stream returning function to pipe in

queueStreams(options, ...streams) ⇒

Create a new queue and pipe given streams and end if some

Kind: global function
Returns: StreamQueue

Param Type Description
options Object The queue options
...streams Readable | function The stream or stream returning function to pipe in