0.0.0 • Published 10 years ago
flow-diff v0.0.0
flow-diff
Transform stream factory to calculate the difference between successive streamed data values.
Installation
$ npm install flow-diff
API
To create a stream factory,
var diffStream = require( 'flow-diff' );
// Create a new factory:
var dStream = diffStream();
dStream.stream()
To create a new difference stream,
var stream = dStream.stream();
Usage
Methods are chainable.
diffStream()
.stream()
.pipe( /* writable stream */ );
Examples
var eventStream = require( 'event-stream' ),
dStream = require( 'flow-diff' );
// Create some data...
var data = new Array( 1000 );
for ( var i = 0; i < data.length; i++ ) {
data[ i ] = Math.round(Math.random()*10);
}
// Create a readable stream:
var readStream = eventStream.readArray( data );
// Create a new difference stream:
var stream = dStream().stream();
// Pipe the data:
readStream
.pipe( stream )
.pipe( eventStream.map( function( d, clbk ){
clbk( null, d.toString()+'\n' );
}))
.pipe( process.stdout );
To run the example code from the top-level application directory,
$ node ./examples/index.js
Tests
Unit tests use the Mocha test framework with Chai assertions.
Assuming you have globally installed Mocha, execute the following command in the top-level application directory to run the tests:
$ mocha
All new feature development should have corresponding unit tests to validate correct functionality.
License
Copyright
Copyright © 2014. Athan Reines.
0.0.0
10 years ago