Class AsyncIter<T>

Type Parameters

T

Hierarchy

AsyncIter

Implements

AsyncIterable<T>
AsyncIterator<T, undefined, undefined>
AsyncIterableIterator<T>

Index

Constructors

Properties

Constructors

constructor

new AsyncIter<T>(iter: AsyncIterator<T, any, undefined>): AsyncIter<T>
Type Parameters
- T
Parameters
- iter: AsyncIterator<T, any, undefined>
Returns AsyncIter<T>
- Defined in async/AsyncIter.ts:30

Properties

`Protected` _index

_index: number = 0

`Protected` _iter

_iter: AsyncIterator<T, any, undefined>

Methods

[asyncIterator]

[asyncIterator](): AsyncIter<T>
Returns AsyncIter<T>
Implementation of AsyncIterable.__@asyncIterator@3320
- Defined in async/AsyncIter.ts:34

all

all(fn: ((value: T, index: number) => boolean)): Promise<boolean>
Parameters
- fn: ((value: T, index: number) => boolean)
  - - (value: T, index: number): boolean
    - Parameters
      
      value: T
      
      index: number
      
      Returns boolean
Returns Promise<boolean>
- Defined in async/AsyncIter.ts:249

any

any(fn: ((value: T, index: number) => boolean)): Promise<boolean>
Parameters
- fn: ((value: T, index: number) => boolean)
  - - (value: T, index: number): boolean
    - Parameters
      
      value: T
      
      index: number
      
      Returns boolean
Returns Promise<boolean>
- Defined in async/AsyncIter.ts:239

concat

concat(iter: AsyncIterator<T, any, undefined>): AsyncMerge<T>
Parameters
- iter: AsyncIterator<T, any, undefined>
Returns AsyncMerge<T>
- Defined in async/AsyncIter.ts:81

consume

consume(): Promise<AsyncIter<T>>
Returns Promise<AsyncIter<T>>
- Defined in async/AsyncIter.ts:132

count

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

enumerate

enumerate(): AsyncEnumerate<T>
Returns AsyncEnumerate<T>
- Defined in async/AsyncIter.ts:56

filter

filter<S>(fn: IAsyncFilterPredicateFn<T, S>): AsyncFilter<T, S>
Type Parameters
- S
Parameters
- fn: IAsyncFilterPredicateFn<T, S>
Returns AsyncFilter<T, S>
- Defined in async/AsyncIter.ts:85
filter(fn: IAsyncFilterBooleanFn<T>): AsyncFilter<T, T>
Parameters
- fn: IAsyncFilterBooleanFn<T>
Returns AsyncFilter<T, T>
- Defined in async/AsyncIter.ts:86

find

find(fn: ((value: T, index: number) => boolean)): Promise<Option<T>>
Parameters
- fn: ((value: T, index: number) => boolean)
  - - (value: T, index: number): boolean
    - Parameters
      
      value: T
      
      index: number
      
      Returns boolean
Returns Promise<Option<T>>
- Defined in async/AsyncIter.ts:183

findAll

findAll(fn: ((value: T) => boolean)): AsyncFilter<T, T>
Parameters
- fn: ((value: T) => boolean)
  - - (value: T): boolean
    - Parameters
      
      value: T
      
      Returns boolean
Returns AsyncFilter<T, T>
- Defined in async/AsyncIter.ts:198

findIndex

findIndex(fn: ((value: T, index: number) => boolean)): Promise<number>
Parameters
- fn: ((value: T, index: number) => boolean)
  - - (value: T, index: number): boolean
    - Parameters
      
      value: T
      
      index: number
      
      Returns boolean
Returns Promise<number>
- Defined in async/AsyncIter.ts:168

first

first(): Promise<Option<T>>
Returns Promise<Option<T>>
- Defined in async/AsyncIter.ts:219

flatten

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

forEach

forEach(fn: IAsyncForEachFn<T>): AsyncForEach<T>
Parameters
- fn: IAsyncForEachFn<T>
Returns AsyncForEach<T>
- Defined in async/AsyncIter.ts:66

indexOf

indexOf(value: T): Promise<number>
Parameters
- value: T
Returns Promise<number>
- Defined in async/AsyncIter.ts:153

iter

iter(): AsyncIter<T>
Returns AsyncIter<T>
- Defined in async/AsyncIter.ts:38

join

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

last

last(): Promise<Option<T>>
Returns Promise<Option<T>>
- Defined in async/AsyncIter.ts:223

map

map<B>(fn: IAsyncMapFn<T, B>): AsyncMap<T, B>
Type Parameters
- B
Parameters
- fn: IAsyncMapFn<T, B>
Returns AsyncMap<T, B>
- Defined in async/AsyncIter.ts:71

merge

merge(iter: AsyncIterator<T, any, undefined>): AsyncMerge<T>
Parameters
- iter: AsyncIterator<T, any, undefined>
Returns AsyncMerge<T>
- Defined in async/AsyncIter.ts:76

next

next(): Promise<IteratorResult<T, undefined>>
Returns Promise<IteratorResult<T, undefined>>
Implementation of AsyncIterator.next
- Defined in async/AsyncIter.ts:42

nextWithIndex

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

none

none(fn: ((value: T, index: number) => boolean)): Promise<boolean>
Parameters
- fn: ((value: T, index: number) => boolean)
  - - (value: T, index: number): boolean
    - Parameters
      
      value: T
      
      index: number
      
      Returns boolean
Returns Promise<boolean>
- Defined in async/AsyncIter.ts:245

nth

nth(index?: number): Promise<Option<T>>
Parameters
- index: number = 0
Returns Promise<Option<T>>
- Defined in async/AsyncIter.ts:202

peekable

peekable(): AsyncPeekable<T>
Returns AsyncPeekable<T>
- Defined in async/AsyncIter.ts:61

reduce

reduce<C>(acc: C, fn: ((acc: C, value: T, index: number) => C)): Promise<C>
Type Parameters
- C
Parameters
- acc: C
- fn: ((acc: C, value: T, index: number) => C)
  - - (acc: C, value: T, index: number): C
    - Parameters
      
      acc: C
      
      value: T
      
      index: number
      
      Returns C
Returns Promise<C>
- Defined in async/AsyncIter.ts:264

reverse

reverse(): AsyncReverse<T>
Returns AsyncReverse<T>
- Defined in async/AsyncIter.ts:124

skip

skip(skip: number): AsyncSkip<T>
Parameters
- skip: number
Returns AsyncSkip<T>
- Defined in async/AsyncIter.ts:96

some

some(fn: ((value: T, index: number) => boolean)): Promise<boolean>
Parameters
- fn: ((value: T, index: number) => boolean)
  - - (value: T, index: number): boolean
    - Parameters
      
      value: T
      
      index: number
      
      Returns boolean
Returns Promise<boolean>
- Defined in async/AsyncIter.ts:242

step

step(step: number): AsyncStep<T>
Parameters
- step: number
Returns AsyncStep<T>
- Defined in async/AsyncIter.ts:91

take

take(count: number): AsyncTake<T>
Parameters
- count: number
Returns AsyncTake<T>
- Defined in async/AsyncIter.ts:101

toArray

toArray(): Promise<T[]>
Returns Promise<T[]>
- Defined in async/AsyncIter.ts:142

toMap

toMap<K, V>(keyFn?: IToMapFn<T, K>, valueFn?: IToMapFn<T, V>): AsyncToMap<T, K, V>
Type Parameters
- K extends string | number | symbol
- V
Parameters
- Optional keyFn: IToMapFn<T, K>
- Optional valueFn: IToMapFn<T, V>
Returns AsyncToMap<T, K, V>
- Defined in async/AsyncIter.ts:106

unflatten

unflatten<U>(fn: IAsyncUnflattenFn<T, U>): AsyncUnflatten<T, U>
Type Parameters
- U
Parameters
- fn: IAsyncUnflattenFn<T, U>
Returns AsyncUnflatten<T, U>
- Defined in async/AsyncIter.ts:119

Generated using TypeDoc