blob: 966bde69c6e1aedbe7596d61a4461ec354d7109d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
|
# merge-stream
Merge (interleave) a bunch of streams.
[](http://travis-ci.org/grncdr/merge-stream)
## Synopsis
```javascript
var stream1 = new Stream();
var stream2 = new Stream();
var merged = mergeStream(stream1, stream2);
var stream3 = new Stream();
merged.add(stream3);
merged.isEmpty();
//=> false
```
## Description
This is adapted from [event-stream](https://github.com/dominictarr/event-stream) separated into a new module, using Streams3.
## API
### `mergeStream`
Type: `function`
Merges an arbitrary number of streams. Returns a merged stream.
#### `merged.add`
A method to dynamically add more sources to the stream. The argument supplied to `add` can be either a source or an array of sources.
#### `merged.isEmpty`
A method that tells you if the merged stream is empty.
When a stream is "empty" (aka. no sources were added), it could not be returned to a gulp task.
So, we could do something like this:
```js
stream = require('merge-stream')();
// Something like a loop to add some streams to the merge stream
// stream.add(streamA);
// stream.add(streamB);
return stream.isEmpty() ? null : stream;
```
## License
MIT
|
