flow-tcp-unmarshal
Transform stream factory to unmarshal TCP transmitted data.
Installation
$ npm install flow-tcp-unmarshal
For use in the browser, use browserify.
Usage
To create a stream factory,
var flowFactory = ;// Create a new factory:var flowStream = ;
The factory has the following methods...
flow.delimiter( [value] )
This method is a setter/getter. If no delimiter
is provided, returns the delimiter
used when delineating streamed data. To set the data delimiter
,
// String:flow;// Regular expression:flow;
The default delimiter
is a line feed: /\r?\n/
.
flow.unmarshal( [format] )
This method is a setter/getter. If no format
is provided, returns the unmarshal format
. To set the format
,
flow;
Available formats include: json
, number
, string
, and boolean
. The default unmarshal format is json
.
flow.stream()
To create a new stream,
var stream = flowStream;
Notes
When used as setters, all setter/getter methods are chainable. For example,
var flowFactory = ;var stream =;
Examples
var eventStream =streamBuffers =flowFactory = ;// Create a readable buffer stream:var source ='frequency': 0 // ms; pipe data immediately;// Create a stream to unmarshal data:var unmarshal =;// Create the pipeline:source;// Write some data...var data;for var i = 0; i < 20; i++data = Math;if i < 20-1data += ' | ';source;
To run the example code from the top-level application directory,
$ node ./examples/index.js
Tests
Unit
Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:
$ make test
All new feature development should have corresponding unit tests to validate correct functionality.
Test Coverage
This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
$ make test-cov
Istanbul creates a ./reports/coverage
directory. To access an HTML version of the report,
$ open reports/coverage/lcov-report/index.html
License
Copyright
Copyright © 2014. Athan Reines.