es-toolkit/dist/fp/array/filter.d.ts

A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.

//#region src/fp/array/filter.d.ts
/**
 * Creates a function that keeps only the elements for which `predicate` returns
 * a truthy value, equivalent to `Array.prototype.filter`. A type predicate
 * narrows the element type of the result. Use it with {@link pipe}.
 *
 * The returned function is **lazy-capable**: inside a {@link pipe} it is fused
 * with adjacent lazy functions and runs element-by-element.
 *
 * @template T - The type of elements in the input array.
 * @template S - The narrowed element type when `predicate` is a type guard.
 * @param predicate - Called with `(value, index)` for each element; return
 *   `true` to keep the element.
 * @returns A function that maps a `readonly T[]` to a filtered array.
 *
 * @example
 * import { pipe, filter } from 'es-toolkit/fp';
 *
 * pipe([1, 2, 3, 4], filter(x => x % 2 === 0)); // => [2, 4]
 *
 * @example
 * // A type guard narrows the result type to `string[]`.
 * pipe([1, 'a', 2, 'b'], filter((x): x is string => typeof x === 'string')); // => ['a', 'b']
 */
declare function filter<T, S extends T>(predicate: (value: T, index: number) => value is S): (array: readonly T[]) => S[];
/**
 * Creates a function that keeps only the elements for which `predicate` returns
 * a truthy value, equivalent to `Array.prototype.filter`. Use it with {@link pipe}.
 *
 * The returned function is **lazy-capable**: inside a {@link pipe} it is fused
 * with adjacent lazy functions and runs element-by-element.
 *
 * @template T - The type of elements in the input array.
 * @param predicate - Called with `(value, index)` for each element; return
 *   `true` to keep the element.
 * @returns A function that maps a `readonly T[]` to a filtered array.
 *
 * @example
 * import { pipe, filter } from 'es-toolkit/fp';
 *
 * pipe([1, 2, 3, 4], filter(x => x % 2 === 0)); // => [2, 4]
 */
declare function filter<T>(predicate: (value: T, index: number) => boolean): (array: readonly T[]) => T[];
//#endregion
export { filter };