@newdash/newdash
Version:
javascript/typescript utility library
30 lines (29 loc) • 1.05 kB
TypeScript
import { Predicate } from "./types";
/**
* This method is like `find` except that it returns the key of the first
* element `predicate` returns truthy for instead of the element itself.
*
* @since 5.2.0
* @category Object
* @param object The object to inspect.
* @param predicate The function invoked per iteration.
* @returns Returns the key of the matched element,
* else `undefined`.
* @see [[find]], [[findIndex]], [[findLast]], [[findLastIndex]], [[findLastKey]]
* @example
*
* ```js
* const users = {
* 'barney': { 'age': 36, 'active': true },
* 'fred': { 'age': 40, 'active': false },
* 'pebbles': { 'age': 1, 'active': true }
* }
*
* findKey(users, ({ age }) => age < 40)
* // => 'barney' (iteration order is not guaranteed)
* ```
*/
export declare function findKey<V>(object: Record<string, V>, predicate?: Predicate<V>): string;
export declare function findKey(object: any, predicate?: Array<any>): string;
export declare function findKey(object: any, predicate?: string): string;
export default findKey;