diff options
Diffstat (limited to 'deps/npm/node_modules/stream-iterate/README.md')
-rw-r--r-- | deps/npm/node_modules/stream-iterate/README.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/deps/npm/node_modules/stream-iterate/README.md b/deps/npm/node_modules/stream-iterate/README.md new file mode 100644 index 0000000000..001112045b --- /dev/null +++ b/deps/npm/node_modules/stream-iterate/README.md @@ -0,0 +1,39 @@ +# stream-iterate + +Iterate through the values in a stream. + +``` +npm install stream-iterate +``` + +[![build status](http://img.shields.io/travis/mafintosh/stream-iterate.svg?style=flat)](http://travis-ci.org/mafintosh/stream-iterate) + +## Usage + +``` js +var iterate = require('stream-iterate') +var from = require('from2') + +var stream = from.obj(['a', 'b', 'c']) + +var read = iterate(stream) + +loop() + +// recursively iterates through each item in the stream +function loop () { + read(function (err, data, next) { + console.log(err, data) + next() + loop() + }) +} +``` + +If you don't call `next` and call `read` again the same `(err, value)` pair will be returned. + +You can use this module to implement stuff like [a streaming merge sort](https://github.com/mafintosh/stream-iterate/blob/master/test.js#L5-L47). + +## License + +[MIT](LICENSE) |