through3

Table of Contents
=================

* Through
* Install
* API
* through3
* extend
* transform
* cork
* passthrough
* Developer
* Test
* Cover
* Documentation
* Readme
* License

Through
=======

.

Stream extends library tracking latest stable node with no external dependencies.

Requires node (>=0.11).

Install

``
npm i through3 --save
`

API

$3

Utilities for creating stream subclass functions.

#### extend

`javascript
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

`javascript
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

`javascript
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

`javascript
passthrough(opts)
`

Get a pass through stream class.

Returns a stream that passes through data.

* opts Object Stream construct options.

Developer

$3

Tests are not included in the package, clone the repository:

`
npm test
`

$3

To generate code coverage run:

`
npm run cover
`

$3

To generate all documentation:

`
npm run docs
`

$3

To build the readme file from the partial definitions (requires mdp):

`
npm run readme
``

License

Everything is MIT. Read the license if you feel inclined.

Generated by mdp(1).

[node]: http://nodejs.org
[npm]: http://www.npmjs.org
[mdp]: https://github.com/tmpfs/mdp