diff options
Diffstat (limited to 'deps/node/deps/npm/node_modules/stream-each/README.md')
| -rw-r--r-- | deps/node/deps/npm/node_modules/stream-each/README.md | 41 |
1 files changed, 0 insertions, 41 deletions
diff --git a/deps/node/deps/npm/node_modules/stream-each/README.md b/deps/node/deps/npm/node_modules/stream-each/README.md deleted file mode 100644 index e0832d55..00000000 --- a/deps/node/deps/npm/node_modules/stream-each/README.md +++ /dev/null @@ -1,41 +0,0 @@ -# stream-each - -Iterate all the data in a stream - -``` -npm install stream-each -``` - -[](http://travis-ci.org/mafintosh/stream-each) - -## Usage - -``` js -var each = require('stream-each') - -each(stream, function (data, next) { - console.log('data from stream', data) - // when ready to consume next chunk - next() -}, function (err) { - console.log('no more data') -}) -``` - -## API - -#### `each(stream, iterator, cb)` - -Iterate the data in the stream by calling the iterator function with `(data, next)` -where data is a data chunk and next is a callback. Call next when you are ready to -consume the next chunk. Optionally you can call next with an error to destroy the stream - -When the stream ends/errors the callback is called if provided - -## License - -MIT - -## Related - -`stream-each` is part of the [mississippi stream utility collection](https://github.com/maxogden/mississippi) which includes more useful stream modules similar to this one. |