Stream extends library tracking latest stable node with no external dependencies.
Requires node (>=0.11).
npm i through3 --save
Utilities for creating stream subclass functions.
extend(type, ctor[, opts])
Creates a stream subclass.
Returns a stream subclass.
type
Function The super class.ctor
Function Constructor for the subclass.opts
Object Default constructor options.
transform(fn[, flush][, opts])
Creates a transform stream subclass.
Returns transform stream subclass.
fn
Function The transform function.flush
Function A flush function.opts
Object Default constructor options.
cork()
Creates a pass through stream subclass that calls cork to buffer all input and write on end.
Useful when you need all the data before operations can begin.
Returns stream class that buffers the input.
passthrough(opts)
Get a pass through stream class.
Returns a stream that passes through data.
opts
Object Stream construct options.
Tests are not included in the package, clone the repository:
npm test
To generate code coverage run:
npm run cover
To generate all documentation:
npm run docs
To build the readme file from the partial definitions (requires mdp):
npm run readme
Everything is MIT. Read the license if you feel inclined.
Generated by mdp(1).