Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

stream-filter

parshap24kPublic Domain2.1.0

Filter data passed through

stream, filter

readme

stream-filter

Filter data using a through stream.

build status

Installation

npm: stream-filter

npm install stream-filter

Example

var filter = require("stream-filter");

process.stdin.pipe(filter(function(data) {
    return data.length > 2;
})).pipe(process.stdout);

Async Filter Function

var filter = require("stream-filter");

process.stdin.pipe(filter.async(function(data, callback) {
    doAsyncThing(data, function(err, size) {
        callback(err, size > 2);
    });
})).pipe(process.stdout);

API

var filter = require("stream-filter");
filter(fn, options);
filter.obj(fn, options);
filter.async(fn, options);
filter.async.obj(fn, options);

Note that filter.obj(fn) and filter.async.obj(fn) are convenience wrappers to pass { objectMode: true }.

See index.js and test.js for API details.