Mirrors/lodash
1
0
Fork 0
mirror of https://github.com/whoisclebs/lodash.git synced 2026-02-03 16:47:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Bump to v3.2.0.

Browse Source
This commit is contained in:
jdalton
2015-02-08 22:05:22 -08:00
parent 9e749daefa
commit 05cb7419a6
92 changed files with 1528 additions and 720 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
object/findKey.js
View File

@@ -6,10 +6,14 @@ var baseCallback = require('../internal/baseCallback'),
* This method is like `_.findIndex` except that it returns the key of the
* first element `predicate` returns truthy for, instead of the element itself.
*
* If a property name is provided for `predicate` the created "_.property"
* If a property name is provided for `predicate` the created `_.property`
* style callback returns the property value of the given element.
*
* If an object is provided for `predicate` the created "_.matches" style
* 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`.
*
@@ -18,8 +22,7 @@ var baseCallback = require('../internal/baseCallback'),
* @category Object
* @param {Object} object The object to search.
* @param {Function|Object|string} [predicate=_.identity] The function invoked
* per iteration. If a property name or object is provided it is used to
* create a "_.property" or "_.matches" style callback respectively.
* per iteration.
* @param {*} [thisArg] The `this` binding of `predicate`.
* @returns {string|undefined} Returns the key of the matched element, else `undefined`.
* @example
@@ -33,11 +36,15 @@ var baseCallback = require('../internal/baseCallback'),
* _.findKey(users, function(chr) { return chr.age < 40; });
* // => 'barney' (iteration order is not guaranteed)
*
* // using the "_.matches" callback shorthand
* _.findKey(users, { 'age': 1 });
* // using the `_.matches` callback shorthand
* _.findKey(users, { 'age': 1, 'active': true });
* // => 'pebbles'
*
* // using the "_.property" callback shorthand
* // using the `_.matchesProperty` callback shorthand
* _.findKey(users, 'active', false);
* // => 'fred'
*
* // using the `_.property` callback shorthand
* _.findKey(users, 'active');
* // => 'barney'
*/