Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
streamfilter
Advanced tools
streamfilter - npm Package Compare versions
Comparing version 1.0.0 to 1.0.1
| { | ||
| "name": "streamfilter", | ||
| "version": "1.0.0", | ||
| "version": "1.0.1", | ||
| "description": "Filtering streams.", | ||
@@ -5,0 +5,0 @@ "main": "src/index.js", |
@@ -1,13 +0,13 @@ | ||
| # filterstream | ||
| # streamfilter | ||
| `filterstream` is a function based filter for streams inspired per gulp-filter | ||
| `streamfilter` is a function based filter for streams inspired per gulp-filter | ||
| but no limited to Gulp nor to objectMode streams. | ||
| [](https://npmjs.org/package/filterstream) [](https://travis-ci.org/nfroidure/filterstream) [](https://david-dm.org/nfroidure/filterstream) [](https://david-dm.org/nfroidure/filterstream#info=devDependencies) [](https://coveralls.io/r/nfroidure/filterstream?branch=master) [](https://codeclimate.com/github/nfroidure/filterstream) | ||
| [](https://npmjs.org/package/streamfilter) [](https://travis-ci.org/nfroidure/streamfilter) [](https://david-dm.org/nfroidure/streamfilter) [](https://david-dm.org/nfroidure/streamfilter#info=devDependencies) [](https://coveralls.io/r/nfroidure/streamfilter?branch=master) [](https://codeclimate.com/github/nfroidure/streamfilter) | ||
| ## Installation | ||
| First install `filterstream` in you project: | ||
| First install `streamfilter` in you project: | ||
| ```sh | ||
| npm install --save filterstream | ||
| npm install --save streamfilter | ||
| ``` | ||
@@ -22,3 +22,3 @@ | ||
| ```js | ||
| var FilterStream = require('filterstream'); | ||
| var FilterStream = require('streamfilter'); | ||
@@ -42,3 +42,3 @@ var filter = new FilterStream(function(chunk, encoding, cb) { | ||
| ```js | ||
| var FilterStream = require('filterstream'); | ||
| var FilterStream = require('streamfilter'); | ||
@@ -66,3 +66,3 @@ var filter = new FilterStream(function(chunk, encoding, cb) { | ||
| ```js | ||
| var FilterStream = require('filterstream'); | ||
| var FilterStream = require('streamfilter'); | ||
@@ -98,7 +98,11 @@ // Filter values | ||
| Filter piped in streams according to the given `filterCallback`. Options are | ||
| passed in as is in the various stream instances spawned by this module. So, | ||
| to use the objectMode, simply pass in the `options.objectMode` value set to | ||
| `true`. | ||
| Filter piped in streams according to the given `filterCallback` that takes the | ||
| following arguments: `chunk` the actual chunk, `encoding` the chunk encoding, | ||
| `filterResultCallback` the function to call as the result of the filtering | ||
| process with `true` in argument to filter her or `false` otherwise. | ||
| Options are passed in as is in the various stream instances spawned by this | ||
| module. So, to use the objectMode, simply pass in the `options.objectMode` | ||
| value set to `true`. | ||
| #### options.restore | ||
@@ -122,4 +126,4 @@ Set to `true`, this option create a readable stream allowing you to use the | ||
| ```sh | ||
| git clone git@github.com:nfroidure/filterstream.git | ||
| cd filterstream | ||
| git clone git@github.com:nfroidure/streamfilter.git | ||
| cd streamfilter | ||
| npm install | ||
@@ -134,4 +138,4 @@ ``` | ||
| ## Stats | ||
| [](https://nodei.co/npm/filterstream/) | ||
| [](https://nodei.co/npm/filterstream/) | ||
| [](https://nodei.co/npm/streamfilter/) | ||
| [](https://nodei.co/npm/streamfilter/) | ||
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by1.66%
14571
- Number of lines in readme file
- increased by3.03%
136
No dependency changes