npm.io
2.1.0 • Published 9 years ago

stream-filter

Licence
Public Domain
Version
2.1.0
Deps
2
Vulns
0
Weekly
0
Stars
5

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.

Keywords