• Take a fixed number of items from an iterable.

    Type Parameters

    • T

    Parameters

    • object: Iterable<T>

      The iterable object of interest.

    • count: number

      The number of items to take from the iterable.

    Returns IterableIterator<T>

    An iterator which yields the specified number of items from the source iterable.

    Notes

    The returned iterator will exhaust early if the source iterable contains an insufficient number of items.

    Example

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

    let stream = take([5, 4, 3, 2, 1, 0, -1], 3);

    Array.from(stream); // [5, 4, 3]