node-stream

#node-stream

A small collection of stream consumers.

Install

The source is available for download from GitHub. Alternatively, you can install using npm:

npm install --save node-stream

You can then require() node-stream as normal:

const nodeStream = require('node-stream');

Documentation

• first
• first.obj
• first.json
• forEach
• forEach.obj
• forEach.json
• wait
• wait.obj
• wait.json

first(stream, onEnd)

Consume the first item in a stream and call a callback with a buffer of that item.

nodeStream.first(
    stream,
    function(err, data) {
        // err is null or an Error object
        // data is a Buffer object
    }
);

first.obj(stream, onEnd)

Consume the first item in a stream and call a callback with that item.

nodeStream.first.obj(
    stream,
    function(err, data) {
        // err is null or an Error object
        // data is an array
    }
);

first.json(stream, onEnd)

Consume the first item in a stream and call a callback with a JSON parsed object. Stream will error if the consumed data is not parseable.

nodeStream.first.json(
    stream,
    function(err, data) {
        // err is null or an Error object
        // data is a JSON parsed object
    }
);

forEach(stream, onData, onEnd)

Iterate through each data tick in a stream and call a callback with that data as a Buffer.

nodeStream.forEach(
    stream,
    function(chunk) {
        // chunk is a Buffer object
    },
    function(err) {
        // err is null or an Error object
    }
);

forEach.obj(stream, onData, onEnd)

Iterate through each data tick in a stream and call a callback with that data. Similar to forEach, except it does not transform the data in any way. This is best used on object streams.

nodeStream.forEach.obj(
    stream,
    function(chunk) {
        // chunk can be of any type
    },
    function(err) {
        // err is null or an Error object
    }
);

forEach.json(stream, onData, onEnd)

Iterate through each data tick in a stream and call a callback with that data. Similar to forEach, but returns a JSON parsed object on the data callback. The stream will error if any tick does not contain valid JSON.

nodeStream.forEach.json(
    stream,
    function(chunk) {
        // chunk will be a JSON parsed object
    },
    function(err) {
        // err is null or an Error object
    }
);

wait(stream, onEnd)

Consume an entire stream and call a callback with a buffer of the data.

nodeStream.wait(
    stream,
    function(err, data) {
        // err is null or an Error object
        // data is a Buffer object
    }
);

wait.obj(stream, onEnd)

Consume an entire stream and call a callback with an array of data. Each tick of the stream is an item in the array.

nodeStream.wait.obj(
    stream,
    function(err, data) {
        // err is null or an Error object
        // data is an array
    }
);

wait.json(stream, onEnd)

Consume an entire stream and call a callback with a JSON parsed object. Stream will error if the consumed data is not parseable.

nodeStream.wait.json(
    stream,
    function(err, data) {
        // err is null or an Error object
        // data is a JSON parsed object
    }
);