@newdash/newdash/every.d.ts

javascript/typescript utility library

/**
 * Checks if `predicate` returns truthy for **all** elements of `collection`.
 * Iteration is stopped once `predicate` returns falsey. The predicate is
 * invoked with three arguments: (value, index|key, collection).
 *
 * **Note:** This method returns `true` for
 * [empty collections](https://en.wikipedia.org/wiki/Empty_set) because
 * [everything is true](https://en.wikipedia.org/wiki/Vacuous_truth) of
 * elements of empty collections.
 *
 * @since 5.3.0
 * @category Collection
 * @param collection The collection to iterate over.
 * @param predicate The function invoked per iteration.
 * @param guard Enables use as an iteratee for methods like `map`.
 * @returns Returns `true` if all elements pass the predicate check,
 *  else `false`.
 * @example
 *
 * ```js
 * every([true, 1, null, 'yes'], Boolean);
 * // => false
 *
 * var users = [
 *   { 'user': 'barney', 'age': 36, 'active': false },
 *   { 'user': 'fred',   'age': 40, 'active': false }
 * ];
 *
 * // The `matches` iteratee shorthand.
 * every(users, { 'user': 'barney', 'active': false });
 * // => false
 *
 * // The `matchesProperty` iteratee shorthand.
 * every(users, ['active', false]);
 * // => true
 *
 * // The `property` iteratee shorthand.
 * every(users, 'active');
 * // => false
 * ```
 */
export declare function every(collection: any[] | object, predicate?: Function, guard?: any): boolean;
export default every;