Skip to content

Latest commit

History

3 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

flow-chunkify

Transform stream factory to chunk streamed data values.

Installation

$ npm install flow-chunkify

API

To create a stream factory,

varchunkStream=require('flow-chunkify');// Create a new factory:varcStream=chunkStream();

cStream.numValues( [numValues] )

This method is a setter/getter. If no numValues is provided, returns the numValues to chunk; default is 1. To set the numValues,

cStream.numValues(10);

cStream.stream()

To create a new chunkify stream,

varstream=cStream.stream();

Usage

Methods are chainable.

chunkStream().numValues(10).stream().pipe(/* writable stream */);

Examples

vareventStream=require('event-stream'),cStream=require('flow-chunkify');// Create some data...vardata=newArray(1000);for(vari=0;i<data.length;i++){data[i]=Math.random();}// Create a readable stream:varreadStream=eventStream.readArray(data);// Create a new chunkify stream:varstream=cStream().numValues(10).stream();// Pipe the data:readStream.pipe(stream).pipe(eventStream.map(function(d,clbk){clbk(null,JSON.stringify(d)+'\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

MIT license.


Copyright

Copyright © 2014. Athan Reines.

About

Transform stream factory to chunk streamed data values.

Resources

Stars

2 stars

Watchers

3 watching

Forks

Releases

Packages

Used by

Contributors

Languages