@newdash/newdash/find.d.ts

javascript/typescript utility library

/**
 * 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 5.2.0
 * @category Collection
 * @param collection The collection to inspect.
 * @param predicate function invoked per iteration.
 * @param fromIndex The index to search from.
 * @returns Returns the first matched element, else `undefined`.
 * @example
 *
 * ```js
 * 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'
 * ```
 */
export declare function find<T>(collection: ArrayLike<T>, predicate: (item: T) => boolean, fromIndex?: number): T | undefined;
export declare function find<T>(collection: ArrayLike<T>, predicate: Partial<T>, fromIndex?: number): T | undefined;
export declare function find<T>(collection: ArrayLike<T>, predicate: Array<keyof T | boolean>, fromIndex?: number): T | undefined;
export declare function find<T>(collection: ArrayLike<T>, predicate: keyof T, fromIndex?: number): T | undefined;
export default find;