Skip to content

Latest commit

History

6 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

flow-add

Transform stream factory to increment streamed numeric data values.

Installation

$ npm install flow-add

API

To create a stream factory,

varaddStream=require('flow-add');// Create a new factory:varaStream=addStream();

aStream.add( [value] )

This method is a setter/getter. If no value is provided, returns the value added to streamed values (a.k.a., the addend); default is 0. To set the value,

aStream.add(100);

aStream.stream()

To create a new addition stream,

varstream=aStream.stream();

Usage

Methods are chainable.

addStream().add(100).stream().pipe(/* writable stream */);

Examples

vareventStream=require('event-stream'),aStream=require('flow-add');// Create some data...vardata=newArray(1000);for(vari=0;i<data.length;i++){data[i]=Math.round(Math.random()*10);}// Create a readable stream:varreadStream=eventStream.readArray(data);// Create a new addition stream:varstream=aStream().add(100).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 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

MIT license.


Copyright

Copyright © 2014. Athan Reines.

About

Transform stream factory to increment streamed numeric data values.

Resources

Stars

2 stars

Watchers

3 watching

Forks

Releases

Packages

Used by

Contributors

Languages