flow-tcp-marshal
Transform stream factory to format data for TCP transmission.
Installation
$ npm install flow-tcp-marshal
For use in the browser, use browserify.
Usage
To create a stream factory,
var flowFactory = ;// Create a new factory:var flow = ;
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 marshalling streamed data. To set the delimiter
,
flow;
The default delimiter
is a line feed: \n
.
flow.marshal( [format] )
This method is a setter/getter. If no format
is provided, returns the marshal format
. To set the format
,
flow;
Available formats include: json
, number
, string
, and boolean
. The default marshal 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 =flowFactory = ;// Create some data...var data = 20 ;for var i = 0; i < datalength; i++data i = Math;// Create a readable stream:var readStream = eventStream;// Create a new stream:var stream =;// Pipe the data:readStream;
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.