@monstermann/fn/dist/array/reject.d.ts

A utility library for TypeScript.

import { ArrayGuard, ArrayPredicate } from "./internals/types.js";

//#region src/array/reject.d.ts

/**
 * `reject(array, predicate)`
 *
 * Returns a new array with elements from `array` that do not satisfy the provided `predicate` function.
 *
 * ```ts
 * reject([1, 2, 3, 4, 5], (x) => x % 2 === 0); // [1, 3, 5]
 * ```
 *
 * ```ts
 * pipe(
 *     [1, 2, 3, 4, 5],
 *     reject((x) => x % 2 === 0),
 * ); // [1, 3, 5]
 * ```
 */
declare const reject: {
  <T, U extends T>(predicate: ArrayGuard<T, U>): (target: T[]) => Exclude<T, U>[];
  <T, U extends T>(predicate: ArrayGuard<T, U>): (target: readonly T[]) => readonly Exclude<T, U>[];
  <T>(predicate: ArrayPredicate<T>): (target: T[]) => T[];
  <T>(predicate: ArrayPredicate<T>): (target: readonly T[]) => readonly T[];
  <T, U extends T>(target: T[], predicate: ArrayGuard<T, U>): Exclude<T, U>[];
  <T, U extends T>(target: readonly T[], predicate: ArrayGuard<T, U>): readonly Exclude<T, U>[];
  <T>(target: T[], predicate: ArrayPredicate<T>): T[];
  <T>(target: readonly T[], predicate: ArrayPredicate<T>): readonly T[];
};
//#endregion
export { reject };