iterator-streams

Iterate over a stack of streams.

This module is intended to be used with loader-cachebut may be used by itself or in other modules.

Install with npm

$ npm i iterator-streams --save

Usage

var iterator = require('iterator-streams');

API

iterator

Iterate over a stack of streams piping the results of each steram to the next stream in the stack.

Params

• stack {Array}: Array of streams to use.
• returns {Function}: Returns a function that will iterator over the given stack of streams.

var fs = require('fs');
var iterator = require('iterator-streams');
var through = require('through2');

var stack = [
  through.obj(function (fp, enc, cb) { this.push(fs.readFileSync(fp, 'utf8')); cb(); }),
  through.obj(function (contents, enc, cb) { this.push(JSON.parse(contents)); cb(); })
];
var readJSON = iterator(stack);
readJSON('./package.json')
  .on('data', console.log);

Related projects

• event-stream: construct pipes of streams of events
• iterator-async: Iterate over a stack of async functions.
• iterator-promise: Iterator over a stack of functions.
• iterator-sync: Iterator over a stack of functions.
• loader-cache: Register loader functions that dynamically read, parse or otherwise transform file contents when the name… more
• through2: A tiny wrapper around Node streams2 Transform to avoid explicit subclassing noise

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Brian Woodward

• github/doowb
• twitter/doowb

License

Copyright © 2015 Brian Woodward Released under the MIT license.

---

This file was generated by verb-cli on June 17, 2015.