Class AsyncToMap<T, K, V>

Type Parameters

T
K extends string | number | symbol
V

Hierarchy

AsyncIter<[K, V]>
- AsyncToMap

Index

Constructors

constructor

Properties

_index _iter

Constructors

constructor

new AsyncToMap<T, K, V>(iter: AsyncIterator<T, any, undefined>, keyFn?: IToMapFn<T, K>, valueFn?: IToMapFn<T, V>): AsyncToMap<T, K, V>
Type Parameters
- T
- K extends string | number | symbol
- V
Parameters
- iter: AsyncIterator<T, any, undefined>
- keyFn: IToMapFn<T, K> = defaultKeyFn
- valueFn: IToMapFn<T, V> = defaultValueFn
Returns AsyncToMap<T, K, V>
Overrides AsyncIter.constructor
- Defined in async/AsyncToMap.ts:11

Properties

`Protected` _index

_index: number = 0

`Protected` _iter

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

Methods

[asyncIterator]

[asyncIterator](): AsyncIter<[K, V]>
Returns AsyncIter<[K, V]>
Inherited from AsyncIter.[asyncIterator]
- Defined in async/AsyncIter.ts:34

all

all(fn: ((value: [K, V], index: number) => boolean)): Promise<boolean>
Parameters
- fn: ((value: [K, V], index: number) => boolean)
  - - (value: [K, V], index: number): boolean
    - Parameters
      
      value: [K, V]
      
      index: number
      
      Returns boolean
Returns Promise<boolean>
Inherited from AsyncIter.all
- Defined in async/AsyncIter.ts:249

any

any(fn: ((value: [K, V], index: number) => boolean)): Promise<boolean>
Parameters
- fn: ((value: [K, V], index: number) => boolean)
  - - (value: [K, V], index: number): boolean
    - Parameters
      
      value: [K, V]
      
      index: number
      
      Returns boolean
Returns Promise<boolean>
Inherited from AsyncIter.any
- Defined in async/AsyncIter.ts:239

concat

concat(iter: AsyncIterator<[K, V], any, undefined>): AsyncMerge<[K, V]>
Parameters
- iter: AsyncIterator<[K, V], any, undefined>
Returns AsyncMerge<[K, V]>
Inherited from AsyncIter.concat
- Defined in async/AsyncIter.ts:81

consume

consume(): Promise<AsyncToMap<T, K, V>>
Returns Promise<AsyncToMap<T, K, V>>
Inherited from AsyncIter.consume
- Defined in async/AsyncIter.ts:132

count

count(): Promise<number>
Returns Promise<number>
Inherited from AsyncIter.count
- Defined in async/AsyncIter.ts:128

enumerate

enumerate(): AsyncEnumerate<[K, V]>
Returns AsyncEnumerate<[K, V]>
Inherited from AsyncIter.enumerate
- Defined in async/AsyncIter.ts:56

filter

filter<S>(fn: IAsyncFilterPredicateFn<[K, V], S>): AsyncFilter<[K, V], S>
Type Parameters
- S extends [K, V]
Parameters
- fn: IAsyncFilterPredicateFn<[K, V], S>
Returns AsyncFilter<[K, V], S>
Inherited from AsyncIter.filter
- Defined in async/AsyncIter.ts:85
filter(fn: IAsyncFilterBooleanFn<[K, V]>): AsyncFilter<[K, V], [K, V]>
Parameters
- fn: IAsyncFilterBooleanFn<[K, V]>
Returns AsyncFilter<[K, V], [K, V]>
Inherited from AsyncIter.filter
- Defined in async/AsyncIter.ts:86

find

find(fn: ((value: [K, V], index: number) => boolean)): Promise<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 Promise<Option<[K, V]>>
Inherited from AsyncIter.find
- Defined in async/AsyncIter.ts:183

findAll

findAll(fn: ((value: [K, V]) => boolean)): AsyncFilter<[K, V], [K, V]>
Parameters
- fn: ((value: [K, V]) => boolean)
  - - (value: [K, V]): boolean
    - Parameters
      
      value: [K, V]
      
      Returns boolean
Returns AsyncFilter<[K, V], [K, V]>
Inherited from AsyncIter.findAll
- Defined in async/AsyncIter.ts:198

findIndex

findIndex(fn: ((value: [K, V], index: number) => boolean)): Promise<number>
Parameters
- fn: ((value: [K, V], index: number) => boolean)
  - - (value: [K, V], index: number): boolean
    - Parameters
      
      value: [K, V]
      
      index: number
      
      Returns boolean
Returns Promise<number>
Inherited from AsyncIter.findIndex
- Defined in async/AsyncIter.ts:168

first

first(): Promise<Option<[K, V]>>
Returns Promise<Option<[K, V]>>
Inherited from AsyncIter.first
- Defined in async/AsyncIter.ts:219

flatten

flatten<D>(depth?: D): AsyncFlatten<[K, V], D>
Type Parameters
- D extends number = 1
Parameters
- Optional depth: D
Returns AsyncFlatten<[K, V], D>
Inherited from AsyncIter.flatten
- Defined in async/AsyncIter.ts:114

forEach

forEach(fn: IAsyncForEachFn<[K, V]>): AsyncForEach<[K, V]>
Parameters
- fn: IAsyncForEachFn<[K, V]>
Returns AsyncForEach<[K, V]>
Inherited from AsyncIter.forEach
- Defined in async/AsyncIter.ts:66

indexOf

indexOf(value: [K, V]): Promise<number>
Parameters
- value: [K, V]
Returns Promise<number>
Inherited from AsyncIter.indexOf
- Defined in async/AsyncIter.ts:153

iter

iter(): AsyncIter<[K, V]>
Returns AsyncIter<[K, V]>
Inherited from AsyncIter.iter
- Defined in async/AsyncIter.ts:38

join

join(separator?: string): Promise<string>
Parameters
- Optional separator: string
Returns Promise<string>
Inherited from AsyncIter.join
- Defined in async/AsyncIter.ts:149

last

last(): Promise<Option<[K, V]>>
Returns Promise<Option<[K, V]>>
Inherited from AsyncIter.last
- Defined in async/AsyncIter.ts:223

map

map<B>(fn: IAsyncMapFn<[K, V], B>): AsyncMap<[K, V], B>
Type Parameters
- B
Parameters
- fn: IAsyncMapFn<[K, V], B>
Returns AsyncMap<[K, V], B>
Inherited from AsyncIter.map
- Defined in async/AsyncIter.ts:71

merge

merge(iter: AsyncIterator<[K, V], any, undefined>): AsyncMerge<[K, V]>
Parameters
- iter: AsyncIterator<[K, V], any, undefined>
Returns AsyncMerge<[K, V]>
Inherited from AsyncIter.merge
- Defined in async/AsyncIter.ts:76

next(): Promise<IteratorResult<[K, V], undefined>>
Returns Promise<IteratorResult<[K, V], undefined>>
Overrides AsyncIter.next
- Defined in async/AsyncToMap.ts:28

nextWithIndex

nextWithIndex(): Promise<IteratorResult<[[K, V], number], undefined>>
Returns Promise<IteratorResult<[[K, V], number], undefined>>
Inherited from AsyncIter.nextWithIndex
- Defined in async/AsyncIter.ts:46

none

none(fn: ((value: [K, V], index: number) => boolean)): Promise<boolean>
Parameters
- fn: ((value: [K, V], index: number) => boolean)
  - - (value: [K, V], index: number): boolean
    - Parameters
      
      value: [K, V]
      
      index: number
      
      Returns boolean
Returns Promise<boolean>
Inherited from AsyncIter.none
- Defined in async/AsyncIter.ts:245

nth

nth(index?: number): Promise<Option<[K, V]>>
Parameters
- index: number = 0
Returns Promise<Option<[K, V]>>
Inherited from AsyncIter.nth
- Defined in async/AsyncIter.ts:202

peekable

peekable(): AsyncPeekable<[K, V]>
Returns AsyncPeekable<[K, V]>
Inherited from AsyncIter.peekable
- Defined in async/AsyncIter.ts:61

reduce

reduce<C>(acc: C, fn: ((acc: C, value: [K, V], index: number) => C)): Promise<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 Promise<C>
Inherited from AsyncIter.reduce
- Defined in async/AsyncIter.ts:264

reverse

reverse(): AsyncReverse<[K, V]>
Returns AsyncReverse<[K, V]>
Inherited from AsyncIter.reverse
- Defined in async/AsyncIter.ts:124

skip

skip(skip: number): AsyncSkip<[K, V]>
Parameters
- skip: number
Returns AsyncSkip<[K, V]>
Inherited from AsyncIter.skip
- Defined in async/AsyncIter.ts:96

some

some(fn: ((value: [K, V], index: number) => boolean)): Promise<boolean>
Parameters
- fn: ((value: [K, V], index: number) => boolean)
  - - (value: [K, V], index: number): boolean
    - Parameters
      
      value: [K, V]
      
      index: number
      
      Returns boolean
Returns Promise<boolean>
Inherited from AsyncIter.some
- Defined in async/AsyncIter.ts:242

step

step(step: number): AsyncStep<[K, V]>
Parameters
- step: number
Returns AsyncStep<[K, V]>
Inherited from AsyncIter.step
- Defined in async/AsyncIter.ts:91

take

take(count: number): AsyncTake<[K, V]>
Parameters
- count: number
Returns AsyncTake<[K, V]>
Inherited from AsyncIter.take
- Defined in async/AsyncIter.ts:101

toArray

toArray(): Promise<[K, V][]>
Returns Promise<[K, V][]>
Inherited from AsyncIter.toArray
- Defined in async/AsyncIter.ts:142

toMap

toMap<K, V>(keyFn?: IToMapFn<[K, V], K>, valueFn?: IToMapFn<[K, V], V>): AsyncToMap<[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 AsyncToMap<[K, V], K, V>
Inherited from AsyncIter.toMap
- Defined in async/AsyncIter.ts:106

toObject

toObject(): Promise<Record<K, V>>
Returns Promise<Record<K, V>>
- Defined in async/AsyncToMap.ts:21

unflatten

unflatten<U>(fn: IAsyncUnflattenFn<[K, V], U>): AsyncUnflatten<[K, V], U>
Type Parameters
- U
Parameters
- fn: IAsyncUnflattenFn<[K, V], U>
Returns AsyncUnflatten<[K, V], U>
Inherited from AsyncIter.unflatten
- Defined in async/AsyncIter.ts:119

Class AsyncToMap<T, K, V>

Type Parameters

T

K extends string | number | symbol

V

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T

K extends string | number | symbol

V

Parameters

iter: AsyncIterator<T, any, undefined>

keyFn: IToMapFn<T, K> = defaultKeyFn

valueFn: IToMapFn<T, V> = defaultValueFn

Returns AsyncToMap<T, K, V>

Properties

Protected _index

Protected _iter

Methods

[asyncIterator]

Returns AsyncIter<[K, V]>

all

Parameters

fn: ((value: [K, V], index: number) => boolean)

Parameters

value: [K, V]

index: number

Returns boolean

Returns Promise<boolean>

any

Parameters

fn: ((value: [K, V], index: number) => boolean)

Parameters

value: [K, V]

index: number

Returns boolean

Returns Promise<boolean>

concat

Parameters

iter: AsyncIterator<[K, V], any, undefined>

Returns AsyncMerge<[K, V]>

consume

Returns Promise<AsyncToMap<T, K, V>>

count

Returns Promise<number>

enumerate

Returns AsyncEnumerate<[K, V]>

filter

Type Parameters

S extends [K, V]

Parameters

fn: IAsyncFilterPredicateFn<[K, V], S>

Returns AsyncFilter<[K, V], S>

Parameters

fn: IAsyncFilterBooleanFn<[K, V]>

Returns AsyncFilter<[K, V], [K, V]>

find

Parameters

fn: ((value: [K, V], index: number) => boolean)

Parameters

value: [K, V]

index: number

Returns boolean

Returns Promise<Option<[K, V]>>

findAll

Parameters

fn: ((value: [K, V]) => boolean)

Parameters

value: [K, V]

Returns boolean

Returns AsyncFilter<[K, V], [K, V]>

findIndex

Parameters

fn: ((value: [K, V], index: number) => boolean)

`Protected` _index

`Protected` _iter

`Optional` depth: D

`Optional` separator: string