.filter(collection, [predicate=.identity])

sourcenpm package

Iterates over elements of collection, returning an array of all elements predicate returns truthy for. The predicate is invoked with three arguments: (value, index|key, collection).Note: Unlike _.remove, this method returns a new array.

Since

0.1.0

Arguments

  • collection (Array|Object): The collection to iterate over.
  • [predicate=.identity] (Function)_: The function invoked per iteration.

Returns

(Array): Returns the new filtered array.

Example

  1. var users = [
    { 'user': 'barney', 'age': 36, 'active': true },
    { 'user': 'fred', 'age': 40, 'active': false }
    ];
    _.filter(users, function(o) { return !o.active; });
    // => objects for ['fred']
    // The `_.matches` iteratee shorthand.
    _.filter(users, { 'age': 36, 'active': true });
    // => objects for ['barney']
    // The `_.matchesProperty` iteratee shorthand.
    _.filter(users, ['active', false]);
    // => objects for ['fred']
    // The `_.property` iteratee shorthand.
    _.filter(users, 'active');
    // => objects for ['barney']