merge2
Merge multiple streams into one stream in sequence or parallel.
Install
Install with npm
npm install merge2
Usage
const gulp = const merge2 = const concat = const minifyHtml = const ngtemplate = gulp
const stream = //...stream//..stream
// equal to merge2([stream1, stream2], stream3)const stream = streamstream
// merge order:// 1. merge `stream1`;// 2. merge `stream2` and `stream3` in parallel after `stream1` merged;// 3. merge 'stream4' after `stream2` and `stream3` merged;const stream = // merge order:// 1. merge `stream5` and `stream6` in parallel after `stream4` merged;// 2. merge 'stream7' after `stream5` and `stream6` merged;stream
// nest merge// equal to merge2(stream1, stream2, stream6, stream3, [stream4, stream5]);const streamA = const streamB = const stream = streamA
API
const merge2 =
merge2()
merge2(options)
merge2(stream1, stream2, ..., streamN)
merge2(stream1, stream2, ..., streamN, options)
merge2(stream1, [stream2, stream3, ...], streamN, options)
return a duplex stream (mergedStream). streams in array will be merged in parallel.
mergedStream.add(stream)
mergedStream.add(stream1, [stream2, stream3, ...], ...)
return the mergedStream.
mergedStream.on('queueDrain', function() {})
It will emit 'queueDrain' when all streams merged. If you set end === false
in options, this event give you a notice that should add more streams to merge or end the mergedStream.
stream
option
Type: Readable
or Duplex
or Transform
stream.
options
option
Type: Object
.
-
end -
Boolean
- ifend === false
then mergedStream will not be auto ended, you should end by yourself. Default:undefined
-
pipeError -
Boolean
- ifpipeError === true
then mergedStream will emiterror
event from source streams. Default:undefined
-
objectMode -
Boolean
. Default:true
objectMode
and other options(highWaterMark
, defaultEncoding
...) is same as Node.js Stream
.
License
MIT © Teambition