You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
57 lines
1.9 KiB
JavaScript
57 lines
1.9 KiB
JavaScript
var baseEach = require('../internal/baseEach'),
|
|
createFind = require('../internal/createFind');
|
|
|
|
/**
|
|
* Iterates over elements of `collection`, returning the first element
|
|
* `predicate` returns truthy for. The predicate is bound to `thisArg` and
|
|
* invoked with three arguments: (value, index|key, collection).
|
|
*
|
|
* If a property name is provided for `predicate` the created `_.property`
|
|
* style callback returns the property value of the given element.
|
|
*
|
|
* If a value is also provided for `thisArg` the created `_.matchesProperty`
|
|
* style callback returns `true` for elements that have a matching property
|
|
* value, else `false`.
|
|
*
|
|
* If an object is provided for `predicate` the created `_.matches` style
|
|
* callback returns `true` for elements that have the properties of the given
|
|
* object, else `false`.
|
|
*
|
|
* @static
|
|
* @memberOf _
|
|
* @alias detect
|
|
* @category Collection
|
|
* @param {Array|Object|string} collection The collection to search.
|
|
* @param {Function|Object|string} [predicate=_.identity] The function invoked
|
|
* per iteration.
|
|
* @param {*} [thisArg] The `this` binding of `predicate`.
|
|
* @returns {*} Returns the matched element, else `undefined`.
|
|
* @example
|
|
*
|
|
* var users = [
|
|
* { 'user': 'barney', 'age': 36, 'active': true },
|
|
* { 'user': 'fred', 'age': 40, 'active': false },
|
|
* { 'user': 'pebbles', 'age': 1, 'active': true }
|
|
* ];
|
|
*
|
|
* _.result(_.find(users, function(chr) {
|
|
* return chr.age < 40;
|
|
* }), 'user');
|
|
* // => 'barney'
|
|
*
|
|
* // using the `_.matches` callback shorthand
|
|
* _.result(_.find(users, { 'age': 1, 'active': true }), 'user');
|
|
* // => 'pebbles'
|
|
*
|
|
* // using the `_.matchesProperty` callback shorthand
|
|
* _.result(_.find(users, 'active', false), 'user');
|
|
* // => 'fred'
|
|
*
|
|
* // using the `_.property` callback shorthand
|
|
* _.result(_.find(users, 'active'), 'user');
|
|
* // => 'barney'
|
|
*/
|
|
var find = createFind(baseEach);
|
|
|
|
module.exports = find;
|