Class ChunksIterator<T, Size>

An iterator that yields non-overlapping values in chunks (tuples) of a certain size.

Type Parameters

T
Size extends number

Implements

IterableIterator<Tuple<T, Size>>

Index

Constructors

Properties

chunk done fill? iterator length

Methods

[iterator] next

Constructors

constructor

new ChunksIterator<T, Size>(iterator, length, fill?): ChunksIterator<T, Size>
Type Parameters
- T
- Size extends number
Parameters
- iterator: Iterator<T, any, any>
- length: Size
- Optionalfill: T
Returns ChunksIterator<T, Size>
- Defined in internal/ChunksIterator.ts:8

Properties

`Protected`chunk

chunk: T[] = []

`Protected`done

done: boolean = false

`Protected` `Optional`fill

fill?: T

`Protected`iterator

iterator: Iterator<T, any, any>

`Protected`length

length: Size

Methods

[iterator]

[iterator](): IterableIterator<Tuple<T, Size>, any, any>
Returns IterableIterator<Tuple<T, Size>, any, any>
Implementation of IterableIterator.[iterator]
- Defined in internal/ChunksIterator.ts:14

next

next(...args): IteratorResult<Tuple<T, Size>, any>
Parameters
- Rest...args: any[]
Returns IteratorResult<Tuple<T, Size>, any>
Implementation of IterableIterator.next
- Defined in internal/ChunksIterator.ts:18