Function filter

  • Filters items in an iterable or asynchronous iterable against a predicate and returns items that evaluated to true.

    Example

    const filterEven = filter((number: number) => number % 2 === 0);

    iterableToArray(filterEven([1, 2, 3, 4])); // [2, 4]
    iterableToArray(filterEven([1, 3, 5, 7])); // []

    Returns

    Curried function with predicate set in context.

    Type Parameters

    • Item

    • Filtered

    Parameters

    • predicate: Predicate<Item, Filtered>

      Predicate function to evaluate each item.

    Returns (<Iterable>(iterable: Iterable) => GeneratorOutput<Iterable>)

      • <Iterable>(iterable: Iterable): GeneratorOutput<Iterable>
      • Type Parameters

        • Iterable extends AsynchronousIterable<Item>

        Parameters

        • iterable: Iterable

        Returns GeneratorOutput<Iterable>