aboutsummaryrefslogtreecommitdiff
path: root/node_modules/merge-stream/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/merge-stream/README.md')
-rw-r--r--node_modules/merge-stream/README.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/node_modules/merge-stream/README.md b/node_modules/merge-stream/README.md
index 862c3a330..966bde69c 100644
--- a/node_modules/merge-stream/README.md
+++ b/node_modules/merge-stream/README.md
@@ -24,11 +24,17 @@ This is adapted from [event-stream](https://github.com/dominictarr/event-stream)
## API
-`merged.add`
+### `mergeStream`
-A method to dynamically add more sources to the stream.
+Type: `function`
-`merged.isEmpty`
+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.