src-stream

src-stream

Wrap readable streams to turn them into passthrough streams.

Install with npm

$ npm i src-stream --save

Usage

var src = require('src-stream');

API

srcStream

Wrap a source stream to passthrough any data that's being written to it.

Params

• stream {Stream}: Readable stream to be wrapped.
• returns {Stream}: Duplex stream to handle reading and writing.

Example

var src = require('src-stream');

// wrap some plugin that creates a readable stream
var stream = src(plugin());

fs.createReadStream('./package.json')
  .pipe(stream)
  .on('data', console.log)
  .on('end', function () {
    console.log();
    console.log('Finished');
    console.log();
  });

Related projects

• duplexify: Turn a writeable and readable stream into a streams2 duplex stream with support for async… more
• merge-stream: Create a stream that emits events from multiple other streams
• stream-loader: create a read stream from a glob of files. can be used as a loader-cache… 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 July 14, 2015.