ts-data-forge
    Preparing search index...

    Function filter

    • Filters an array based on a predicate function.

      Type Parameters

      • const Ar extends readonly unknown[]
      • S extends unknown

      Parameters

      • array: Ar
      • predicate: (a: Ar[number], index: ArrayIndex<Ar>) => a is S

      Returns readonly S[]

      const numbers = [1, 2, 3, 4] as const;

      const evens = Arr.filter(numbers, (value) => value % 2 === 0);
      const greaterThanTwo = Arr.filter<number>((value) => value > 2)(numbers);

      assert.deepStrictEqual(evens, [2, 4]);
      assert.deepStrictEqual(greaterThanTwo, [3, 4]);

    • Filters an array based on a predicate function.

      Type Parameters

      • E
      • S

      Parameters

      • predicate: (a: E, index: Uint32) => a is S

      Returns (array: readonly E[]) => readonly S[]

      const numbers = [1, 2, 3, 4] as const;

      const evens = Arr.filter(numbers, (value) => value % 2 === 0);
      const greaterThanTwo = Arr.filter<number>((value) => value > 2)(numbers);

      assert.deepStrictEqual(evens, [2, 4]);
      assert.deepStrictEqual(greaterThanTwo, [3, 4]);

    • Filters an array based on a predicate function.

      Type Parameters

      • const Ar extends readonly unknown[]

      Parameters

      • array: Ar
      • predicate: (a: Ar[number], index: ArrayIndex<Ar>) => boolean

      Returns readonly Ar[number][]

      const numbers = [1, 2, 3, 4] as const;

      const evens = Arr.filter(numbers, (value) => value % 2 === 0);
      const greaterThanTwo = Arr.filter<number>((value) => value > 2)(numbers);

      assert.deepStrictEqual(evens, [2, 4]);
      assert.deepStrictEqual(greaterThanTwo, [3, 4]);

    • Filters an array based on a predicate function.

      Type Parameters

      • E

      Parameters

      • predicate: (a: E, index: Uint32) => boolean

      Returns (array: readonly E[]) => readonly E[]

      const numbers = [1, 2, 3, 4] as const;

      const evens = Arr.filter(numbers, (value) => value % 2 === 0);
      const greaterThanTwo = Arr.filter<number>((value) => value > 2)(numbers);

      assert.deepStrictEqual(evens, [2, 4]);
      assert.deepStrictEqual(greaterThanTwo, [3, 4]);

    Settings

    Member Visibility