wallet-core/node_modules/merge-stream/README.md

56 lines
1.2 KiB
Markdown
Raw Normal View History

2016-10-10 03:43:44 +02:00
# merge-stream
Merge (interleave) a bunch of streams.
[![build status](https://secure.travis-ci.org/grncdr/merge-stream.svg?branch=master)](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`
2016-10-10 03:43:44 +02:00
Type: `function`
2016-10-10 03:43:44 +02:00
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`
2016-10-10 03:43:44 +02:00
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