Class Flatten<T, D>

Type Parameters

T
D extends number = 1

Hierarchy

Iter<IFlatIteratorType<T, D>>
- Flatten

Index

Constructors

constructor

Properties

_index _iter

Constructors

constructor

new Flatten<T, D>(iter: Iterator<T, any, undefined>, depth?: D): Flatten<T, D>
Type Parameters
- T
- D extends number = 1
Parameters
- iter: Iterator<T, any, undefined>
- depth: D = ...
Returns Flatten<T, D>
Overrides Iter.constructor
- Defined in Flatten.ts:42

Properties

`Protected` _index

_index: number = 0

`Protected` _iter

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

Methods

[iterator]

[iterator](): Iter<IFlatIteratorType<T, D>>
Returns Iter<IFlatIteratorType<T, D>>
Inherited from Iter.[iterator]
- Defined in Iter.ts:29

all

all(fn: ((value: IFlatIteratorType<T, D>, index: number) => boolean)): 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 boolean
Inherited from Iter.all
- Defined in Iter.ts:244

any

any(fn: ((value: IFlatIteratorType<T, D>, index: number) => boolean)): 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 boolean
Inherited from Iter.any
- Defined in Iter.ts:234

concat

concat(iter: Iterator<IFlatIteratorType<T, D>, any, undefined>): Merge<IFlatIteratorType<T, D>>
Parameters
- iter: Iterator<IFlatIteratorType<T, D>, any, undefined>
Returns Merge<IFlatIteratorType<T, D>>
Inherited from Iter.concat
- Defined in Iter.ts:76

consume

consume(): Flatten<T, D>
Returns Flatten<T, D>
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<IFlatIteratorType<T, D>>
Returns Enumerate<IFlatIteratorType<T, D>>
Inherited from Iter.enumerate
- Defined in Iter.ts:51

filter

filter<S>(fn: IFilterPredicateFn<IFlatIteratorType<T, D>, S>): Filter<IFlatIteratorType<T, D>, S>
Type Parameters
- S
Parameters
- fn: IFilterPredicateFn<IFlatIteratorType<T, D>, S>
Returns Filter<IFlatIteratorType<T, D>, S>
Inherited from Iter.filter
- Defined in Iter.ts:80
filter(fn: IFilterBooleanFn<IFlatIteratorType<T, D>>): Filter<IFlatIteratorType<T, D>, IFlatIteratorType<T, D>>
Parameters
- fn: IFilterBooleanFn<IFlatIteratorType<T, D>>
Returns Filter<IFlatIteratorType<T, D>, IFlatIteratorType<T, D>>
Inherited from Iter.filter
- Defined in Iter.ts:81

find

find(fn: ((value: IFlatIteratorType<T, D>, index: number) => boolean)): 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 Option<IFlatIteratorType<T, D>>
Inherited from Iter.find
- Defined in Iter.ts:178

findAll

findAll(fn: ((value: IFlatIteratorType<T, D>) => boolean)): Filter<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 Filter<IFlatIteratorType<T, D>, IFlatIteratorType<T, D>>
Inherited from Iter.findAll
- Defined in Iter.ts:193

findIndex

findIndex(fn: ((value: IFlatIteratorType<T, D>, index: number) => boolean)): 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 number
Inherited from Iter.findIndex
- Defined in Iter.ts:163

first

first(): Option<IFlatIteratorType<T, D>>
Returns Option<IFlatIteratorType<T, D>>
Inherited from Iter.first
- Defined in Iter.ts:214

flatten

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

forEach

forEach(fn: IForEachFn<IFlatIteratorType<T, D>>): ForEach<IFlatIteratorType<T, D>>
Parameters
- fn: IForEachFn<IFlatIteratorType<T, D>>
Returns ForEach<IFlatIteratorType<T, D>>
Inherited from Iter.forEach
- Defined in Iter.ts:61

indexOf

indexOf(value: IFlatIteratorType<T, D>): number
Parameters
- value: IFlatIteratorType<T, D>
Returns number
Inherited from Iter.indexOf
- Defined in Iter.ts:148

iter

iter(): Iter<IFlatIteratorType<T, D>>
Returns Iter<IFlatIteratorType<T, D>>
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<IFlatIteratorType<T, D>>
Returns Option<IFlatIteratorType<T, D>>
Inherited from Iter.last
- Defined in Iter.ts:218

map

map<B>(fn: IMapFn<IFlatIteratorType<T, D>, B>): Map<IFlatIteratorType<T, D>, B>
Type Parameters
- B
Parameters
- fn: IMapFn<IFlatIteratorType<T, D>, B>
Returns Map<IFlatIteratorType<T, D>, B>
Inherited from Iter.map
- Defined in Iter.ts:66

merge

merge(iter: Iterator<IFlatIteratorType<T, D>, any, undefined>): Merge<IFlatIteratorType<T, D>>
Parameters
- iter: Iterator<IFlatIteratorType<T, D>, any, undefined>
Returns Merge<IFlatIteratorType<T, D>>
Inherited from Iter.merge
- Defined in Iter.ts:71

next(): IteratorResult<IFlatIteratorType<T, D>, any>
Returns IteratorResult<IFlatIteratorType<T, D>, any>
Overrides Iter.next
- Defined in Flatten.ts:47

nextWithIndex

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

none

none(fn: ((value: IFlatIteratorType<T, D>, index: number) => boolean)): 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 boolean
Inherited from Iter.none
- Defined in Iter.ts:240

nth

nth(index?: number): Option<IFlatIteratorType<T, D>>
Parameters
- index: number = 0
Returns Option<IFlatIteratorType<T, D>>
Inherited from Iter.nth
- Defined in Iter.ts:197

peekable

peekable(): Peekable<IFlatIteratorType<T, D>>
Returns Peekable<IFlatIteratorType<T, D>>
Inherited from Iter.peekable
- Defined in Iter.ts:56

reduce

reduce<C>(acc: C, fn: ((acc: C, value: IFlatIteratorType<T, D>, index: number) => C)): 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 C
Inherited from Iter.reduce
- Defined in Iter.ts:259

reverse

reverse(): Reverse<IFlatIteratorType<T, D>>
Returns Reverse<IFlatIteratorType<T, D>>
Inherited from Iter.reverse
- Defined in Iter.ts:119

skip

skip(skip: number): Skip<IFlatIteratorType<T, D>>
Parameters
- skip: number
Returns Skip<IFlatIteratorType<T, D>>
Inherited from Iter.skip
- Defined in Iter.ts:91

some

some(fn: ((value: IFlatIteratorType<T, D>, index: number) => boolean)): 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 boolean
Inherited from Iter.some
- Defined in Iter.ts:237

step

step(step: number): Step<IFlatIteratorType<T, D>>
Parameters
- step: number
Returns Step<IFlatIteratorType<T, D>>
Inherited from Iter.step
- Defined in Iter.ts:86

take

take(count: number): Take<IFlatIteratorType<T, D>>
Parameters
- count: number
Returns Take<IFlatIteratorType<T, D>>
Inherited from Iter.take
- Defined in Iter.ts:96

toArray

toArray(): IFlatIteratorType<T, D>[]
Returns IFlatIteratorType<T, D>[]
Inherited from Iter.toArray
- Defined in Iter.ts:137

toMap

toMap<K, V>(keyFn?: IToMapFn<IFlatIteratorType<T, D>, K>, valueFn?: IToMapFn<IFlatIteratorType<T, D>, V>): ToMap<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 ToMap<IFlatIteratorType<T, D>, K, V>
Inherited from Iter.toMap
- Defined in Iter.ts:101

unflatten

unflatten<U>(fn: IUnflattenFn<IFlatIteratorType<T, D>, U>): Unflatten<IFlatIteratorType<T, D>, U>
Type Parameters
- U
Parameters
- fn: IUnflattenFn<IFlatIteratorType<T, D>, U>
Returns Unflatten<IFlatIteratorType<T, D>, U>
Inherited from Iter.unflatten
- Defined in Iter.ts:114

Class Flatten<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: Iterator<T, any, undefined>

depth: D = ...

Returns Flatten<T, D>

Properties

Protected _index

Protected _iter

Methods

[iterator]

Returns Iter<IFlatIteratorType<T, D>>

all

Parameters

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

Parameters

value: IFlatIteratorType<T, D>

index: number

Returns boolean

Returns boolean

any

Parameters

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

Parameters

value: IFlatIteratorType<T, D>

index: number

Returns boolean

Returns boolean

concat

Parameters

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

Returns Merge<IFlatIteratorType<T, D>>

consume

Returns Flatten<T, D>

count

Returns number

enumerate

Returns Enumerate<IFlatIteratorType<T, D>>

filter

Type Parameters

S

Parameters

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

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

Parameters

fn: IFilterBooleanFn<IFlatIteratorType<T, D>>

Returns Filter<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 Option<IFlatIteratorType<T, D>>

findAll

Parameters

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

Parameters

value: IFlatIteratorType<T, D>

Returns boolean

Returns Filter<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