Function windows

  • windows<T, Length extends number>(
        length: Length,
        offset: number,
        fill: T,
    ): (arg: IteratorOrIterable<T>) => IterableIterator<Tuple<T, Length>>

    Yields sliding windows (tuples) of length from the input iterator. Each window is separated by offset number of elements.

    Type Parameters

    • T
    • Length extends number

    Parameters

    • length: Length

      The length of each window, must be greater than 0.

    • offset: number

      The offset of each window from each other. Must be greater than 0.

    • fill: T

      Optional, the value to fill the last window with if it's not the same length as the rest of the iterator.

    Returns (arg: IteratorOrIterable<T>) => IterableIterator<Tuple<T, Length>>

    Example

    toArray(windows([1,2,3,4,5], 2, 1)) // [[1,2], [2,3], [3,4], [4,5]]
    toArray(windows([1,2,3,4,5], 2, 3)) // [[1,2], [4,5]]
    toArray(windows([1,2,3,4,5], 3, 3, 0)) // [[1,2,3], [4,5,0]]
  • windows<T, Length extends number>(
        length: Length,
        offset: number,
    ): (arg: T) => IterableIterator<IterSource<T>[]>

    Yields sliding windows (tuples) of length from the input iterator. Each window is separated by offset number of elements.

    Type Parameters

    • T
    • Length extends number

    Parameters

    • length: Length

      The length of each window, must be greater than 0.

    • offset: number

      The offset of each window from each other. Must be greater than 0.

    Returns (arg: T) => IterableIterator<IterSource<T>[]>

    Example

    toArray(windows([1,2,3,4,5], 2, 1)) // [[1,2], [2,3], [3,4], [4,5]]
    toArray(windows([1,2,3,4,5], 2, 3)) // [[1,2], [4,5]]
    toArray(windows([1,2,3,4,5], 3, 3, 0)) // [[1,2,3], [4,5,0]]
  • windows<T, Length extends number>(
        arg: IteratorOrIterable<T>,
        length: Length,
        offset: number,
        fill: T,
    ): IterableIterator<Tuple<T, Length>>

    Yields sliding windows (tuples) of length from the input iterator. Each window is separated by offset number of elements.

    Type Parameters

    • T
    • Length extends number

    Parameters

    • arg: IteratorOrIterable<T>

      The input iterator.

    • length: Length

      The length of each window, must be greater than 0.

    • offset: number

      The offset of each window from each other. Must be greater than 0.

    • fill: T

      Optional, the value to fill the last window with if it's not the same length as the rest of the iterator.

    Returns IterableIterator<Tuple<T, Length>>

    Example

    toArray(windows([1,2,3,4,5], 2, 1)) // [[1,2], [2,3], [3,4], [4,5]]
    toArray(windows([1,2,3,4,5], 2, 3)) // [[1,2], [4,5]]
    toArray(windows([1,2,3,4,5], 3, 3, 0)) // [[1,2,3], [4,5,0]]
  • windows<T, Length extends number>(
        arg: IteratorOrIterable<T>,
        length: Length,
        offset: number,
    ): IterableIterator<T[]>

    Yields sliding windows (tuples) of length from the input iterator. Each window is separated by offset number of elements.

    Type Parameters

    • T
    • Length extends number

    Parameters

    • arg: IteratorOrIterable<T>

      The input iterator.

    • length: Length

      The length of each window, must be greater than 0.

    • offset: number

      The offset of each window from each other. Must be greater than 0.

    Returns IterableIterator<T[]>

    Example

    toArray(windows([1,2,3,4,5], 2, 1)) // [[1,2], [2,3], [3,4], [4,5]]
    toArray(windows([1,2,3,4,5], 2, 3)) // [[1,2], [4,5]]
    toArray(windows([1,2,3,4,5], 3, 3, 0)) // [[1,2,3], [4,5,0]]

Settings

Member Visibility