Class GroupByIterator<T, K>

Groups values in the input iterator by some key identifier function or property.

Type Parameters

T
K extends KeyIdentifier<T>

Implements

IterableIterator<[KeyIdentifiersValue<T, K>, T[]]>

Index

Constructors

Properties

currGroup currKey done iterator key

Methods

[iterator] getKey next

Constructors

constructor

new GroupByIterator<T, K extends string | number | symbol | Iteratee<T, any>>(
iterator: Iterator<T>,
key: K,
): GroupByIterator<T, K>
Type Parameters
- T
- K extends string | number | symbol | Iteratee<T, any>
Parameters
- iterator: Iterator<T>
- key: K
Returns GroupByIterator<T, K>
- Defined in src/internal/GroupByIterator.ts:11

Properties

`Protected`currGroup

currGroup: T[] = []

`Protected`currKey

currKey: undefined | KeyIdentifiersValue<T, K>

`Protected`done

done: boolean = false

`Protected`iterator

iterator: Iterator<T>

`Protected`key

key: K

Methods

[iterator]

"[iterator]"(): IterableIterator<[KeyIdentifiersValue<T, K>, T[]]>
Returns IterableIterator<[KeyIdentifiersValue<T, K>, T[]]>
Implementation of IterableIterator.[iterator]
- Defined in src/internal/GroupByIterator.ts:16

getKey

getKey(value: T): KeyIdentifiersValue<T, K>
Parameters
- value: T
Returns KeyIdentifiersValue<T, K>
- Defined in src/internal/GroupByIterator.ts:51

next

next(): IteratorResult<[KeyIdentifiersValue<T, K>, T[]]>
Returns IteratorResult<[KeyIdentifiersValue<T, K>, T[]]>
Implementation of IterableIterator.next
- Defined in src/internal/GroupByIterator.ts:20