ts-iterable-functions
    Preparing search index...

    Function _filter

    • _filter<T, S>(src: Iterable<T>, pred: TypeGuardPredicate<T, S>): Iterable<S>

      Filters items from a source iterable using a predicate, optionally narrowing the element type.

      Type Parameters

      • T

        Element type produced by the source iterable.

      • S

        Narrowed element type when pred acts as a type guard.

      Parameters

      • src: Iterable<T>

        Source iterable evaluated synchronously.

      • pred: TypeGuardPredicate<T, S>

        Predicate invoked with each element and its index to determine inclusion.

      Returns Iterable<S>

      A deferred iterable yielding every element for which pred returns a truthy value.

      Error Rethrows any error thrown by pred.

      const odds = [..._filter([1, 2, 3, 4], (value) => value % 2 === 1)];
      console.log(odds); // [1, 3]
    • _filter<T>(src: Iterable<T>, pred: IndexedPredicate<T>): Iterable<T>

      Filters items from a source iterable using a predicate, optionally narrowing the element type.

      Type Parameters

      • T

        Element type produced by the source iterable.

      Parameters

      • src: Iterable<T>

        Source iterable evaluated synchronously.

      • pred: IndexedPredicate<T>

        Predicate invoked with each element and its index to determine inclusion.

      Returns Iterable<T>

      A deferred iterable yielding every element for which pred returns a truthy value.

      Error Rethrows any error thrown by pred.

      const odds = [..._filter([1, 2, 3, 4], (value) => value % 2 === 1)];
      console.log(odds); // [1, 3]

    Settings

    Member Visibility