Function filter

  • Filter an iterable for values which pass a test.

    Type Parameters

    • T

    Parameters

    • object: Iterable<T>

      The iterable object of interest.

    • fn: ((value, index) => boolean)

      The predicate function to invoke for each value.

        • (value, index): boolean
        • Parameters

          • value: T
          • index: number

          Returns boolean

    Returns IterableIterator<T>

    An iterator which yields the values which pass the test.

    Example

    import { filter } from '@lumino/algorithm';

    let data = [1, 2, 3, 4, 5, 6];

    let stream = filter(data, value => value % 2 === 0);

    Array.from(stream); // [2, 4, 6]