.find(collection, [predicate=.identity], [fromIndex=0])

sourcenpm package

Iterates over elements of collection, returning the first element predicate returns truthy for. The predicate is invoked with three arguments: (value, index|key, collection).

Since

0.1.0

Arguments

  • collection (Array|Object): The collection to inspect.
  • [predicate=.identity] (Function)_: The function invoked per iteration.
  • [fromIndex=0] (number): The index to search from.

Returns

(*): Returns the matched element, else undefined.

Example

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