Class AsyncFlatten<T, D>

Type Parameters

T
D extends number = 1

Hierarchy

AsyncIter<IFlatIteratorType<T, D>>
- AsyncFlatten

Index

Constructors

constructor

Properties

_index _iter

Constructors

constructor

new AsyncFlatten<T, D>(iter: AsyncIterator<T, any, undefined>, depth?: D): AsyncFlatten<T, D>
Type Parameters
- T
- D extends number = 1
Parameters
- iter: AsyncIterator<T, any, undefined>
- depth: D = ...
Returns AsyncFlatten<T, D>
Overrides AsyncIter.constructor
- Defined in async/AsyncFlatten.ts:11

Properties

`Protected` _index

_index: number = 0

`Protected` _iter

_iter: AsyncIterator<IFlatIteratorType<T, D>, any, undefined>

Methods

[asyncIterator]

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

all

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

any

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

concat

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

consume

consume(): Promise<AsyncFlatten<T, D>>
Returns Promise<AsyncFlatten<T, D>>
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<IFlatIteratorType<T, D>>
Returns AsyncEnumerate<IFlatIteratorType<T, D>>
Inherited from AsyncIter.enumerate
- Defined in async/AsyncIter.ts:56

filter

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

find

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

findAll

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

findIndex

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

first

first(): Promise<Option<IFlatIteratorType<T, D>>>
Returns Promise<Option<IFlatIteratorType<T, D>>>
Inherited from AsyncIter.first
- Defined in async/AsyncIter.ts:219

flatten

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

forEach

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

indexOf

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

iter

iter(): AsyncIter<IFlatIteratorType<T, D>>
Returns AsyncIter<IFlatIteratorType<T, D>>
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<IFlatIteratorType<T, D>>>
Returns Promise<Option<IFlatIteratorType<T, D>>>
Inherited from AsyncIter.last
- Defined in async/AsyncIter.ts:223

map

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

merge

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

next(): Promise<IteratorResult<IFlatIteratorType<T, D>, any>>
Returns Promise<IteratorResult<IFlatIteratorType<T, D>, any>>
Overrides AsyncIter.next
- Defined in async/AsyncFlatten.ts:16

nextWithIndex

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

none

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

nth

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

peekable

peekable(): AsyncPeekable<IFlatIteratorType<T, D>>
Returns AsyncPeekable<IFlatIteratorType<T, D>>
Inherited from AsyncIter.peekable
- Defined in async/AsyncIter.ts:61

reduce

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

reverse

reverse(): AsyncReverse<IFlatIteratorType<T, D>>
Returns AsyncReverse<IFlatIteratorType<T, D>>
Inherited from AsyncIter.reverse
- Defined in async/AsyncIter.ts:124

skip

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

some

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

step

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

take

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

toArray

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

toMap

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

unflatten

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

Class AsyncFlatten<T, D>

Type Parameters

T

D extends number = 1

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T

D extends number = 1

Parameters

iter: AsyncIterator<T, any, undefined>

depth: D = ...

Returns AsyncFlatten<T, D>

Properties

Protected _index

Protected _iter

Methods

[asyncIterator]

Returns AsyncIter<IFlatIteratorType<T, D>>

all

Parameters

fn: ((value: IFlatIteratorType<T, D>, index: number) => boolean)

Parameters

value: IFlatIteratorType<T, D>

index: number

Returns boolean

Returns Promise<boolean>

any

Parameters

fn: ((value: IFlatIteratorType<T, D>, index: number) => boolean)

Parameters

value: IFlatIteratorType<T, D>

index: number

Returns boolean

Returns Promise<boolean>

concat

Parameters

iter: AsyncIterator<IFlatIteratorType<T, D>, any, undefined>

Returns AsyncMerge<IFlatIteratorType<T, D>>

consume

Returns Promise<AsyncFlatten<T, D>>

count

Returns Promise<number>

enumerate

Returns AsyncEnumerate<IFlatIteratorType<T, D>>

filter

Type Parameters

S

Parameters

fn: IAsyncFilterPredicateFn<IFlatIteratorType<T, D>, S>

Returns AsyncFilter<IFlatIteratorType<T, D>, S>

Parameters

fn: IAsyncFilterBooleanFn<IFlatIteratorType<T, D>>

Returns AsyncFilter<IFlatIteratorType<T, D>, IFlatIteratorType<T, D>>

find

Parameters

fn: ((value: IFlatIteratorType<T, D>, index: number) => boolean)

Parameters

value: IFlatIteratorType<T, D>

index: number

Returns boolean

Returns Promise<Option<IFlatIteratorType<T, D>>>

findAll

Parameters

fn: ((value: IFlatIteratorType<T, D>) => boolean)

Parameters

value: IFlatIteratorType<T, D>

Returns boolean

Returns AsyncFilter<IFlatIteratorType<T, D>, IFlatIteratorType<T, D>>

findIndex

Parameters

fn: ((value: IFlatIteratorType<T, D>, index: number) => boolean)

Parameters

value: IFlatIteratorType<T, D>

index: number

`Protected` _index

`Protected` _iter

`Optional` depth: D

`Optional` separator: string