aboutsummaryrefslogtreecommitdiff
path: root/node_modules/stream-consume/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/stream-consume/README.md
parenta0247c6a3fd6a09a41a7e35a3441324c4dcb58be (diff)
downloadwallet-core-abd94a7f5a50f43c797a11b53549ae48fff667c3.tar.xz
add node_modules to address #4364
Diffstat (limited to 'node_modules/stream-consume/README.md')
-rw-r--r--node_modules/stream-consume/README.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/node_modules/stream-consume/README.md b/node_modules/stream-consume/README.md
new file mode 100644
index 000000000..d7c9c909b
--- /dev/null
+++ b/node_modules/stream-consume/README.md
@@ -0,0 +1,53 @@
+# stream-consume
+
+A node module ensures a Readable stream continues flowing if it's not piped to
+another destination.
+
+ npm install stream-consume
+
+## Usage
+
+Simply pass a stream to `stream-consume`.
+Both legacy streams and streams2 are supported.
+
+``` js
+var consume = require('stream-consume');
+
+consume(readableStream);
+```
+
+## Details
+
+Only Readable streams are processed (as determined by presence of `readable`
+property and a `resume` property that is a function). If called with anything
+else, it's a NOP.
+
+For a streams2 stream (as determined by presence of a `_readableState`
+property), nothing is done if the stream has already been piped to at least
+one other destination.
+
+`resume()` is used to cause the stream to continue flowing.
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2014 Aron Nopanen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.