aboutsummaryrefslogtreecommitdiff
path: root/node_modules/merge-stream/README.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2016-10-10 03:43:44 +0200
committerFlorian Dold <florian.dold@gmail.com>2016-10-10 03:43:44 +0200
commitabd94a7f5a50f43c797a11b53549ae48fff667c3 (patch)
treeab8ed457f65cdd72e13e0571d2975729428f1551 /node_modules/merge-stream/README.md
parenta0247c6a3fd6a09a41a7e35a3441324c4dcb58be (diff)
downloadwallet-core-abd94a7f5a50f43c797a11b53549ae48fff667c3.tar.xz
add node_modules to address #4364
Diffstat (limited to 'node_modules/merge-stream/README.md')
-rw-r--r--node_modules/merge-stream/README.md49
1 files changed, 49 insertions, 0 deletions
diff --git a/node_modules/merge-stream/README.md b/node_modules/merge-stream/README.md
new file mode 100644
index 000000000..862c3a330
--- /dev/null
+++ b/node_modules/merge-stream/README.md
@@ -0,0 +1,49 @@
+# 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
+
+`merged.add`
+
+A method to dynamically add more sources to the stream.
+
+`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