filter-function

filter-function

Create a filter function that can recursively match against objects, and use regex

Install

yarn add filter-function

Usage

import filterFunction from 'filter-function';
// or const filterFunction = require('filter-function').default;

const filterFooBar = filterFunction({ foo: 'bar' });
const items = [
  { foo: 'bar' },
  { foo: 'baz' },
  { foo: 'qux' },
];

console.log(items.filter(filterFooBar)); // [{ foo: 'bar' }]

API details

filter-function only checks for the properties listed in the checking object, extraneous properties on the target object are ignored.

Regular expressions

filter-function also supports regular expressions, use as such:

const filterFooBar = filterFunction({ foo: /bar/ });

Nested objects

filter-function also supports nested objects, use as such:

const filterFooBar = filterFunction({ foo: { bar: 'baz' } });

Contribute

PRs accepted.

License

ISC © Michael Leaney