Class Enumerate<T>

Type parameters

T

Hierarchy

Iter<[number, T]>
- Enumerate

Index

Constructors

constructor

Properties

_index
_iter

Methods

Constructors

constructor

new Enumerate<T>(iter: Iterator<T, any, undefined>): Enumerate<T>

Overrides Iter.constructor
- Defined in iter/Enumerate.ts:4
Type parameters
- T
Parameters
- iter: Iterator<T, any, undefined>
Returns Enumerate<T>

Properties

Protected _index

_index: number = 0

Protected _iter

_iter: Iterator<[number, T], any, undefined>

Methods

[iterator]

[iterator](): IterableIterator<[number, T]>

Inherited from Iter.[iterator]
- Defined in iter/Iter.ts:28
Returns IterableIterator<[number, T]>

all

all(fn: (value: [number, T], index: number) => boolean): boolean

Inherited from Iter.all
- Defined in iter/Iter.ts:229
Parameters
- fn: (value: [number, T], index: number) => boolean
  - - (value: [number, T], index: number): boolean
    - Parameters
      - value: [number, T]
      - index: number
      Returns boolean
Returns boolean

any

any(fn: (value: [number, T], index: number) => boolean): boolean

Inherited from Iter.any
- Defined in iter/Iter.ts:219
Parameters
- fn: (value: [number, T], index: number) => boolean
  - - (value: [number, T], index: number): boolean
    - Parameters
      - value: [number, T]
      - index: number
      Returns boolean
Returns boolean

concat

concat(iter: Iterator<[number, T], any, undefined>): Merge<[number, T]>

Inherited from Iter.concat
- Defined in iter/Iter.ts:75
Parameters
- iter: Iterator<[number, T], any, undefined>
Returns Merge<[number, T]>

consume

consume(): Enumerate<T>

Inherited from Iter.consume
- Defined in iter/Iter.ts:112
Returns Enumerate<T>

count

count(): number

Inherited from Iter.count
- Defined in iter/Iter.ts:108
Returns number

enumerate

enumerate(): Enumerate<[number, T]>

Inherited from Iter.enumerate
- Defined in iter/Iter.ts:50
Returns Enumerate<[number, T]>

filter

filter<S>(fn: IFilterPredicateFn<[number, T], S>): Filter<[number, T], S>
filter(fn: IFilterBooleanFn<[number, T]>): Filter<[number, T], [number, T]>

Inherited from Iter.filter
- Defined in iter/Iter.ts:79
Type parameters
- S: [number, T]
Parameters
- fn: IFilterPredicateFn<[number, T], S>
Returns Filter<[number, T], S>
Inherited from Iter.filter
- Defined in iter/Iter.ts:80
Parameters
- fn: IFilterBooleanFn<[number, T]>
Returns Filter<[number, T], [number, T]>

find

find(fn: (value: [number, T], index: number) => boolean): Option<[number, T]>

Inherited from Iter.find
- Defined in iter/Iter.ts:163
Parameters
- fn: (value: [number, T], index: number) => boolean
  - - (value: [number, T], index: number): boolean
    - Parameters
      - value: [number, T]
      - index: number
      Returns boolean
Returns Option<[number, T]>

findAll

findAll(fn: (value: [number, T]) => boolean): Filter<[number, T], [number, T]>

Inherited from Iter.findAll
- Defined in iter/Iter.ts:178
Parameters
- fn: (value: [number, T]) => boolean
  - - (value: [number, T]): boolean
    - Parameters
      - value: [number, T]
      Returns boolean
Returns Filter<[number, T], [number, T]>

findIndex

findIndex(fn: (value: [number, T], index: number) => boolean): number

Inherited from Iter.findIndex
- Defined in iter/Iter.ts:148
Parameters
- fn: (value: [number, T], index: number) => boolean
  - - (value: [number, T], index: number): boolean
    - Parameters
      - value: [number, T]
      - index: number
      Returns boolean
Returns number

first

first(): Option<[number, T]>

Inherited from Iter.first
- Defined in iter/Iter.ts:199
Returns Option<[number, T]>

forEach

forEach(fn: IForEachFn<[number, T]>): ForEach<[number, T]>

Inherited from Iter.forEach
- Defined in iter/Iter.ts:60
Parameters
- fn: IForEachFn<[number, T]>
Returns ForEach<[number, T]>

indexOf

indexOf(value: [number, T]): number

Inherited from Iter.indexOf
- Defined in iter/Iter.ts:133
Parameters
- value: [number, T]
Returns number

iter

iter(): Iter<[number, T]>

Inherited from Iter.iter
- Defined in iter/Iter.ts:32
Returns Iter<[number, T]>

join

join(separator?: string): string

Inherited from Iter.join
- Defined in iter/Iter.ts:129
Parameters
- Optional separator: string
Returns string

last

last(): Option<[number, T]>

Inherited from Iter.last
- Defined in iter/Iter.ts:203
Returns Option<[number, T]>

map

map<B>(fn: IMapFn<[number, T], B>): Map<[number, T], B>

Inherited from Iter.map
- Defined in iter/Iter.ts:65
Type parameters
- B
Parameters
- fn: IMapFn<[number, T], B>
Returns Map<[number, T], B>

merge

merge(iter: Iterator<[number, T], any, undefined>): Merge<[number, T]>

Inherited from Iter.merge
- Defined in iter/Iter.ts:70
Parameters
- iter: Iterator<[number, T], any, undefined>
Returns Merge<[number, T]>

next

next(): IteratorResult<[number, T], undefined>

Overrides Iter.next
- Defined in iter/Enumerate.ts:8
Returns IteratorResult<[number, T], undefined>

nextWithIndex

nextWithIndex(): IteratorResult<[[number, T], number], undefined>

Inherited from Iter.nextWithIndex
- Defined in iter/Iter.ts:40
Returns IteratorResult<[[number, T], number], undefined>

none

none(fn: (value: [number, T], index: number) => boolean): boolean

Inherited from Iter.none
- Defined in iter/Iter.ts:225
Parameters
- fn: (value: [number, T], index: number) => boolean
  - - (value: [number, T], index: number): boolean
    - Parameters
      - value: [number, T]
      - index: number
      Returns boolean
Returns boolean

nth

nth(index?: number): Option<[number, T]>

Inherited from Iter.nth
- Defined in iter/Iter.ts:182
Parameters
- index: number = 0
Returns Option<[number, T]>

peekable

peekable(): Peekable<[number, T]>

Inherited from Iter.peekable
- Defined in iter/Iter.ts:55
Returns Peekable<[number, T]>

reduce

reduce<C>(acc: C, fn: (acc: C, value: [number, T], index: number) => C): C

Inherited from Iter.reduce
- Defined in iter/Iter.ts:249
Type parameters
- C
Parameters
- acc: C
- fn: (acc: C, value: [number, T], index: number) => C
  - - (acc: C, value: [number, T], index: number): C
    - Parameters
      - acc: C
      - value: [number, T]
      - index: number
      Returns C
Returns C

reverse

reverse(): Iter<[number, T]>

Inherited from Iter.reverse
- Defined in iter/Iter.ts:261
Returns Iter<[number, T]>

skip

skip(skip: number): Skip<[number, T]>

Inherited from Iter.skip
- Defined in iter/Iter.ts:90
Parameters
- skip: number
Returns Skip<[number, T]>

some

some(fn: (value: [number, T], index: number) => boolean): boolean

Inherited from Iter.some
- Defined in iter/Iter.ts:222
Parameters
- fn: (value: [number, T], index: number) => boolean
  - - (value: [number, T], index: number): boolean
    - Parameters
      - value: [number, T]
      - index: number
      Returns boolean
Returns boolean

step

step(step: number): Step<[number, T]>

Inherited from Iter.step
- Defined in iter/Iter.ts:85
Parameters
- step: number
Returns Step<[number, T]>

take

take(count: number): Take<[number, T]>

Inherited from Iter.take
- Defined in iter/Iter.ts:95
Parameters
- count: number
Returns Take<[number, T]>

toArray

toArray(): [number, T][]

Inherited from Iter.toArray
- Defined in iter/Iter.ts:122
Returns [number, T][]

toMap

toMap<K, V>(keyFn?: IToMapFn<[number, T], K>, valueFn?: IToMapFn<[number, T], V>): ToMap<[number, T], K, V>

Inherited from Iter.toMap
- Defined in iter/Iter.ts:100
Type parameters
- K: string | number | symbol
- V
Parameters
- Optional keyFn: IToMapFn<[number, T], K>
- Optional valueFn: IToMapFn<[number, T], V>
Returns ToMap<[number, T], K, V>

unflatten

unflatten<U>(fn: UnflattenFn<[number, T], U>): Unflatten<[number, T], U>

Inherited from Iter.unflatten
- Defined in iter/Iter.ts:244
Type parameters
- U
Parameters
- fn: UnflattenFn<[number, T], U>
Returns Unflatten<[number, T], U>

Generated using TypeDoc