npm

Join us for the upcoming webinar, "Enterprise JavaScript done right: the tools you love, the security you need."Sign up here »

filter-object

3.0.0 • Public • Published

filter-object NPM version NPM monthly downloads NPM total downloads Linux Build Status

Filter an object by its keys or values. Returns a copy of an object filtered to have only keys or values that match the given glob patterns.

Install

Install with npm:

$ npm install --save filter-object

Usage

Filter with glob patterns

var filter = require('filter-object');
 
console.log(filter({a: 'a', b: 'b', c: 'c'}, '*'));
//=> {a: 'a', b: 'b', c: 'c'}
 
console.log(filter({a: 'a', b: 'b', c: 'c'}, 'b'));
//=> {b: 'b'}
 
console.log(filter({foo: 'a', bar: 'b', baz: 'c'}, 'b*'));
//=> {bar: 'b', baz: 'c'}
 
console.log(filter({a: 'a', b: 'b', c: 'c'}, '{b,c}'));
//=> {b: 'b', c: 'c'}
 
console.log(filter({a: 'a', b: 'b', c: 'c'}, ['a', 'b']));
//=> {a: 'a', b: 'b'}

Negation patterns

console.log(filter({foo: 'a', bar: 'b', baz: 'c'}, ['!b*']));
//=> { foo: 'a' }
 
console.log(filter({a: {b: {foo: 'a', bar: 'b', baz: 'c'}}}, ['!a.b.b*']));
//=> {a: {b: {foo: 'a'}}}

options

Options are passed to glob-object and/or filter-values

filter({foo: 'a', bar: 'b', baz: 'c'}, ['*', '!b*'], options);

See glob-object and/or filter-values for the full range of options and available features.

About

Related projects

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.6.0, on June 19, 2017.

install

npm i filter-object

Downloadsweekly downloads

1,451

version

3.0.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability