Skip to content package
deep-filter v1.0.0 Recursively filters collection values (arrays and objects)
node any 1 deps cjs open source
overview readme
license MIT
deps 1
unpacked Unknown
files Unknown
node any $ npm install deep-filter@1.0.0n npmREADME GitHub-flavored package documentation.
downloads Across all versions.
Download trend unavailable.
compatibility Runtime metadata.
keywords Tagged topics.
filter deep array object collection
versions Latest published Apr 3, 2017
maintainers Registry package owners.
contents deep-filter
Recursively filters collections (arrays and objects).
Installation
$ npm install deep-filter - NPM
$ bower install deep-filter - bower
The browser file is named index.umd.js which supports CommonJS, AMD and globals (deepFilter).
If you want to run this module on old browsers, you must include es5-shim .
Usage
Examples bellow are based on nodejs.
// Example 1 - Remove all strings equal to 'foo'
var deepfilter = require ( 'deep-filter' );
deepfilter ({
prop1: 'foo' ,
prop2: [ 'foo' , 'bar' ],
prop3: [ 'foo' , 'foo' ],
prop4: {
prop5: 'foo' ,
prop6: 'bar'
}
}, function (value, prop, subject) {
// prop is an array index or an object key
// subject is either an array or an object
return value !== 'foo' ;
});
/*
{
prop2: [ 'bar' ],
prop3: [],
prop4: {
Tests
$ npm test
License
Released under the MIT License .
install size Estimated unpacked size across 2 packages.
6.6 kB
Includes dependencies.
dependencies 1 direct · 1 outdated
prop6: 'bar'
}
}
*/
// Example 2 - Filter empty values
var deepfilter = require ( 'deep-filter' );
function notEmpty (value, prop, subject) {
var key;
if (Array. isArray (value)) {
return value.length > 0 ;
} else if ( !! value && typeof value === 'object' && value.constructor === Object) {
for (key in value) {
return true ;
}
return false ;
} else if ( typeof value === 'string' ) {
return value.length > 0 ;
} else {
return value != null;
}
}
deepfilter ({
something: [
{
colors: [ 'red' , 'green' , '' ],
cars: { audi: 'nice' , vw: 'good' , aston: '' }
},
undefined,
''
],
foo: 'bar'
}, notEmpty);
/*
{
something: [
{
colors: ['red', 'green'],
cars: { audi: 'nice', vw: 'good' }
}
],
foo: 'bar'
});
*/
// Example 3 - Filter empty values + trim strings
// Just to demonstrate that subject properties can be manipulated while filtering
var deepfilter = require ( 'deep-filter' );
function notEmpty (value, prop, subject) {
var key;
if (Array. isArray (value)) {
return value.length > 0 ;
} else if ( !! value && typeof value === 'object' && value.constructor === Object) {
for (key in value) {
return true ;
}
return false ;
} else if ( typeof value === 'string' ) {
subject[prop] = value = value. trim ();
return value.length > 0 ;
} else {
return value != null;
}
}
deepfilter ({
something: [
{
colors: [ 'red' , ' green ' , '' ],
cars: { audi: 'nice' , vw: 'good' , aston: ' ' }
},
undefined,
''
],
foo: 'bar'
}, notEmpty);
/*
{
something: [
{
colors: ['red', 'green'],
cars: { audi: 'nice', vw: 'good' }
}
],
foo: 'bar'
});
*/
copy