ts-prime/dist/es/filter.d.ts

A utility library for JavaScript and Typescript.

import { LazyResult } from './_reduceLazy';
import { Pred, PredIndexedOptional, PredIndexed } from './_types';
/**
 * Filter the elements of an array that meet the condition specified in a callback function.
 * @param array The array to filter.
 * @param fn the callback function.
 * @signature
 *    P.filter(array, fn)
 * @signature
 *    P.filter(fn)(array)
 * @example
 *    P.filter([1, 2, 3], x => x % 2 === 1) // => [1, 3]
 *
 *    P.pipe([1, 2, 3], P.filter(x => x % 2 === 1)) // => [1, 3]
 * @category Array, Pipe
 */
export declare function filter<T, S extends T>(array: readonly T[], fn: (value: T) => value is S): S[];
export declare function filter<T>(array: readonly T[], fn: Pred<T, boolean>): T[];
export declare function filter<T, S extends T>(fn: (input: T) => input is S): (array: readonly T[]) => S[];
export declare function filter<T>(fn: Pred<T, boolean>): (array: readonly T[]) => T[];
export declare namespace filter {
    function indexed<T, S extends T>(array: readonly T[], fn: (input: T, index: number, array: readonly T[]) => input is S): S[];
    function indexed<T>(array: readonly T[], fn: PredIndexed<T, boolean>): T[];
    /**
     * @data_last
     */
    function indexed<T, S extends T>(fn: (input: T, index: number, array: readonly T[]) => input is S): (array: readonly T[]) => S[];
    function indexed<T>(fn: PredIndexed<T, boolean>): (array: readonly T[]) => T[];
    const lazy: <T>(fn: PredIndexedOptional<T, boolean>) => (value: T, index?: number | undefined, array?: readonly T[] | undefined) => LazyResult<T>;
    const lazyIndexed: (<T>(fn: PredIndexedOptional<T, boolean>) => (value: T, index?: number | undefined, array?: readonly T[] | undefined) => LazyResult<T>) & {
        indexed: true;
    };
}
//# sourceMappingURL=filter.d.ts.map