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>(iterator, key): GroupByIterator<T, K>
Type Parameters
- T
- K extends
      | string
      | number
      | symbol
      | Iteratee<T, any>
Parameters
- iterator: Iterator<T, any, any>
- key: K
Returns GroupByIterator<T, K>
- Defined in 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, any, any>

`Protected`key

key: K

Methods

[iterator]

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

getKey

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

next

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