Class ToMap<T, K, V>

Type Parameters

T
K extends string | number | symbol
V

Hierarchy

Iter<[K, V]>
- ToMap

Index

Constructors

Properties

Constructors

constructor

new ToMap<T, K, V>(iter: Iterator<T, any, undefined>, keyFn?: IToMapFn<T, K>, valueFn?: IToMapFn<T, V>): ToMap<T, K, V>
Type Parameters
- T
- K extends string | number | symbol
- V
Parameters
- iter: Iterator<T, any, undefined>
- keyFn: IToMapFn<T, K> = defaultKeyFn
- valueFn: IToMapFn<T, V> = defaultValueFn
Returns ToMap<T, K, V>
Overrides Iter.constructor
- Defined in ToMap.ts:13

Properties

`Protected` _index

_index: number = 0

`Protected` _iter

_iter: Iterator<[K, V], any, undefined>

Methods

[iterator]

[iterator](): Iter<[K, V]>
Returns Iter<[K, V]>
Inherited from Iter.[iterator]
- Defined in Iter.ts:29

all

all(fn: ((value: [K, V], index: number) => boolean)): boolean
Parameters
- fn: ((value: [K, V], index: number) => boolean)
  - - (value: [K, V], index: number): boolean
    - Parameters
      
      value: [K, V]
      
      index: number
      
      Returns boolean
Returns boolean
Inherited from Iter.all
- Defined in Iter.ts:244

any

any(fn: ((value: [K, V], index: number) => boolean)): boolean
Parameters
- fn: ((value: [K, V], index: number) => boolean)
  - - (value: [K, V], index: number): boolean
    - Parameters
      
      value: [K, V]
      
      index: number
      
      Returns boolean
Returns boolean
Inherited from Iter.any
- Defined in Iter.ts:234

concat

concat(iter: Iterator<[K, V], any, undefined>): Merge<[K, V]>
Parameters
- iter: Iterator<[K, V], any, undefined>
Returns Merge<[K, V]>
Inherited from Iter.concat
- Defined in Iter.ts:76

consume

consume(): ToMap<T, K, V>
Returns ToMap<T, K, V>
Inherited from Iter.consume
- Defined in Iter.ts:127

count

count(): number
Returns number
Inherited from Iter.count
- Defined in Iter.ts:123

enumerate

enumerate(): Enumerate<[K, V]>
Returns Enumerate<[K, V]>
Inherited from Iter.enumerate
- Defined in Iter.ts:51

filter

filter<S>(fn: IFilterPredicateFn<[K, V], S>): Filter<[K, V], S>
Type Parameters
- S extends [K, V]
Parameters
- fn: IFilterPredicateFn<[K, V], S>
Returns Filter<[K, V], S>
Inherited from Iter.filter
- Defined in Iter.ts:80
filter(fn: IFilterBooleanFn<[K, V]>): Filter<[K, V], [K, V]>
Parameters
- fn: IFilterBooleanFn<[K, V]>
Returns Filter<[K, V], [K, V]>
Inherited from Iter.filter
- Defined in Iter.ts:81

find

find(fn: ((value: [K, V], index: number) => boolean)): Option<[K, V]>
Parameters
- fn: ((value: [K, V], index: number) => boolean)
  - - (value: [K, V], index: number): boolean
    - Parameters
      
      value: [K, V]
      
      index: number
      
      Returns boolean
Returns Option<[K, V]>
Inherited from Iter.find
- Defined in Iter.ts:178

findAll

findAll(fn: ((value: [K, V]) => boolean)): Filter<[K, V], [K, V]>
Parameters
- fn: ((value: [K, V]) => boolean)
  - - (value: [K, V]): boolean
    - Parameters
      
      value: [K, V]
      
      Returns boolean
Returns Filter<[K, V], [K, V]>
Inherited from Iter.findAll
- Defined in Iter.ts:193

findIndex

findIndex(fn: ((value: [K, V], index: number) => boolean)): number
Parameters
- fn: ((value: [K, V], index: number) => boolean)
  - - (value: [K, V], index: number): boolean
    - Parameters
      
      value: [K, V]
      
      index: number
      
      Returns boolean
Returns number
Inherited from Iter.findIndex
- Defined in Iter.ts:163

first

first(): Option<[K, V]>
Returns Option<[K, V]>
Inherited from Iter.first
- Defined in Iter.ts:214

flatten

flatten<D>(depth?: D): Flatten<[K, V], D>
Type Parameters
- D extends number = 1
Parameters
- Optional depth: D
Returns Flatten<[K, V], D>
Inherited from Iter.flatten
- Defined in Iter.ts:109

forEach

forEach(fn: IForEachFn<[K, V]>): ForEach<[K, V]>
Parameters
- fn: IForEachFn<[K, V]>
Returns ForEach<[K, V]>
Inherited from Iter.forEach
- Defined in Iter.ts:61

indexOf

indexOf(value: [K, V]): number
Parameters
- value: [K, V]
Returns number
Inherited from Iter.indexOf
- Defined in Iter.ts:148

iter

iter(): Iter<[K, V]>
Returns Iter<[K, V]>
Inherited from Iter.iter
- Defined in Iter.ts:33

join

join(separator?: string): string
Parameters
- Optional separator: string
Returns string
Inherited from Iter.join
- Defined in Iter.ts:144

last

last(): Option<[K, V]>
Returns Option<[K, V]>
Inherited from Iter.last
- Defined in Iter.ts:218

map

map<B>(fn: IMapFn<[K, V], B>): Map<[K, V], B>
Type Parameters
- B
Parameters
- fn: IMapFn<[K, V], B>
Returns Map<[K, V], B>
Inherited from Iter.map
- Defined in Iter.ts:66

merge

merge(iter: Iterator<[K, V], any, undefined>): Merge<[K, V]>
Parameters
- iter: Iterator<[K, V], any, undefined>
Returns Merge<[K, V]>
Inherited from Iter.merge
- Defined in Iter.ts:71

next

next(): IteratorResult<[K, V], undefined>
Returns IteratorResult<[K, V], undefined>
Overrides Iter.next
- Defined in ToMap.ts:30

nextWithIndex

nextWithIndex(): IteratorResult<[[K, V], number], undefined>
Returns IteratorResult<[[K, V], number], undefined>
Inherited from Iter.nextWithIndex
- Defined in Iter.ts:41

none

none(fn: ((value: [K, V], index: number) => boolean)): boolean
Parameters
- fn: ((value: [K, V], index: number) => boolean)
  - - (value: [K, V], index: number): boolean
    - Parameters
      
      value: [K, V]
      
      index: number
      
      Returns boolean
Returns boolean
Inherited from Iter.none
- Defined in Iter.ts:240

nth

nth(index?: number): Option<[K, V]>
Parameters
- index: number = 0
Returns Option<[K, V]>
Inherited from Iter.nth
- Defined in Iter.ts:197

peekable

peekable(): Peekable<[K, V]>
Returns Peekable<[K, V]>
Inherited from Iter.peekable
- Defined in Iter.ts:56

reduce

reduce<C>(acc: C, fn: ((acc: C, value: [K, V], index: number) => C)): C
Type Parameters
- C
Parameters
- acc: C
- fn: ((acc: C, value: [K, V], index: number) => C)
  - - (acc: C, value: [K, V], index: number): C
    - Parameters
      
      acc: C
      
      value: [K, V]
      
      index: number
      
      Returns C
Returns C
Inherited from Iter.reduce
- Defined in Iter.ts:259

reverse

reverse(): Reverse<[K, V]>
Returns Reverse<[K, V]>
Inherited from Iter.reverse
- Defined in Iter.ts:119

skip

skip(skip: number): Skip<[K, V]>
Parameters
- skip: number
Returns Skip<[K, V]>
Inherited from Iter.skip
- Defined in Iter.ts:91

some

some(fn: ((value: [K, V], index: number) => boolean)): boolean
Parameters
- fn: ((value: [K, V], index: number) => boolean)
  - - (value: [K, V], index: number): boolean
    - Parameters
      
      value: [K, V]
      
      index: number
      
      Returns boolean
Returns boolean
Inherited from Iter.some
- Defined in Iter.ts:237

step

step(step: number): Step<[K, V]>
Parameters
- step: number
Returns Step<[K, V]>
Inherited from Iter.step
- Defined in Iter.ts:86

take

take(count: number): Take<[K, V]>
Parameters
- count: number
Returns Take<[K, V]>
Inherited from Iter.take
- Defined in Iter.ts:96

toArray

toArray(): [K, V][]
Returns [K, V][]
Inherited from Iter.toArray
- Defined in Iter.ts:137

toMap

toMap<K, V>(keyFn?: IToMapFn<[K, V], K>, valueFn?: IToMapFn<[K, V], V>): ToMap<[K, V], K, V>
Type Parameters
- K extends string | number | symbol
- V
Parameters
- Optional keyFn: IToMapFn<[K, V], K>
- Optional valueFn: IToMapFn<[K, V], V>
Returns ToMap<[K, V], K, V>
Inherited from Iter.toMap
- Defined in Iter.ts:101

toObject

toObject(): Record<K, V>
Returns Record<K, V>
- Defined in ToMap.ts:23

unflatten

unflatten<U>(fn: IUnflattenFn<[K, V], U>): Unflatten<[K, V], U>
Type Parameters
- U
Parameters
- fn: IUnflattenFn<[K, V], U>
Returns Unflatten<[K, V], U>
Inherited from Iter.unflatten
- Defined in Iter.ts:114

Generated using TypeDoc