Package Exports

filter-object

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (filter-object) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

filter-object

Return a copy of an object, filtered to have only keys that match the given glob patterns.

Install with npm

npm i filter-object --save

Usage

Filter with glob patterns

var filter = require('filter-object');

filter({a: 'a', b: 'b', c: 'c'}, '*');
//=> {a: 'a', b: 'b', c: 'c'}

filter({a: 'a', b: 'b', c: 'c'}, 'b');
//=> {b: 'b'}

filter({foo: 'a', bar: 'b', baz: 'c'}, 'b*');
//=> {bar: 'b', baz: 'c'}

filter({a: 'a', b: 'b', c: 'c'}, '{b,c}');
//=> {b: 'b', c: 'c'}

Negation patterns work as well:

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

options

Pass options to sort-object and/or filter-keys

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

See sort-object for the full range of options and features.

Filter with a callback function

filter({a: 'a', b: 'b', c: 'c'}, function(value, key, obj) {
  return key !== 'b';
});
//=> {a: 'a', c: 'c'}


filter({a: 'a', b: 'b', c: 'c'}, function(value, key, obj) {
  return key === 'b';
});
//=> {b: 'b'}

filter({a: 'a', b: 'b', c: 'c'}, function(value, key, obj) {
  return value === 'b';
});
//=> {b: 'b'}

Run tests

Install dev dependencies:

npm i -d && npm test

Contributing

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

Author

Jon Schlinkert

License

This file was generated by verb-cli on March 30, 2015.