Need private packages and team management tools?Check out npm Teams »

crispy-stream

0.1.2 • Public • Published

Crispy Stream

Build Status Code Climate Test Coverage

Lets imagine you want to test how a lib you created behaves when using its 'stream-mode' and, of course you don't want to read and write from file system. So what should you do? Well you should use this package which is an implementation of Stream.

Because this library implements Node's Stream abstract interface you can use it as you would any other Stream implementation.

Installation

 $ npm install crispy-stream

Require Crispy Stream

  var crispyStream = require('crispy-stream');

Read Stream.

Creating Read Stream Using a Factory.

If you prefer to have functions creating your streams rather than using the new operator yourself.

  // With buffer input.
  var buff = new Buffer('sample text');
  var readable = crispyStream.createReadStream(buff);
 
  // With simple string.
  var readable = crispyStream.createReadStream('sample text');

Creating New Read Stream Using The new Operator.

In case you fancy the Pseudo-classical way.

  var Readable = crispyStream.Readable;
 
  // With buffer input.
  var buff = new Buffer('sample text');
  var readable = new Readable(buff);
 
  // With simple string.
  var readable = new Readable('sample text');

Write Stream.

Creating Write Stream Using a Factory.

  var writable = crispyStream.createWriteStream();

Creating Write Stream Using The new Operator.

  var Writable = crispyStream.Writable;
  var writable = new Writable();

Piping.

Just as every stream library, you can pipe things from a read stream to a write stream.

Between Crispy Streams.

  var input = 'pipe this';
  var pipable = crispyStream.createReadStream(input);
  var writable = crispyStream.createWriteStream();
 
  pipable.pipe(writable);

Between Crispy Stream and Native Stream.

Native Readable to Crispy Writable

  var fs = require('fs');
  var input = '/path/to/input';
  var pipable = fs.createReadStream(input);
  var writable = crispyStream.createWriteStream();
 
  pipable.pipe(writable);

Crispy Readable to Native Writable

  var fs = require('fs');
  var input = 'pipe this';
  var filename = '/path/to/output';
  var pipable = crispyStream.createReadStream(input);
  var writable = fs.createWriteStream(filename);
 
  pipable.pipe(writable);

Install

npm i crispy-stream

DownloadsWeekly Downloads

1

Version

0.1.2

License

MIT

Last publish

Collaborators

  • avatar