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

through3

Utilities for creating stream subclass functions.

extend

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

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

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

passthrough(opts)

Get a pass through stream class.

Returns a stream that passes through data.

• opts Object Stream construct options.

Developer

Test

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

npm test

Cover

To generate code coverage run:

npm run cover

Documentation

To generate all documentation:

npm run docs

Readme

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).