Class Filter<T, S>

Type parameters

T
S: T

Hierarchy

Iter<S>
- Filter

Index

Constructors

constructor

Properties

_index
_iter

Methods

Constructors

constructor

new Filter<T, S>(iter: Iterator<T, any, undefined>, fn: IFilterBooleanFn<T> | IFilterPredicateFn<T, S>): Filter<T, S>

Overrides Iter.constructor
- Defined in iter/Filter.ts:12
Type parameters
- T
- S
Parameters
- iter: Iterator<T, any, undefined>
- fn: IFilterBooleanFn<T> | IFilterPredicateFn<T, S>
Returns Filter<T, S>

Properties

Protected _index

_index: number = 0

Protected _iter

_iter: Iterator<S, any, undefined>

Methods

[iterator]

[iterator](): IterableIterator<S>

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

all

all(fn: (value: S, index: number) => boolean): boolean

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

any

any(fn: (value: S, index: number) => boolean): boolean

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

concat

concat(iter: Iterator<S, any, undefined>): Merge<S>

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

consume

consume(): Filter<T, S>

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

count

count(): number

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

enumerate

enumerate(): Enumerate<S>

Inherited from Iter.enumerate
- Defined in iter/Iter.ts:50
Returns Enumerate<S>

filter

filter<S>(fn: IFilterPredicateFn<S, S>): Filter<S, S>
filter(fn: IFilterBooleanFn<S>): Filter<S, S>

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

find

find(fn: (value: S, index: number) => boolean): Option<S>

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

findAll

findAll(fn: (value: S) => boolean): Filter<S, S>

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

findIndex

findIndex(fn: (value: S, index: number) => boolean): number

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

first

first(): Option<S>

Inherited from Iter.first
- Defined in iter/Iter.ts:199
Returns Option<S>

forEach

forEach(fn: IForEachFn<S>): ForEach<S>

Inherited from Iter.forEach
- Defined in iter/Iter.ts:60
Parameters
- fn: IForEachFn<S>
Returns ForEach<S>

indexOf

indexOf(value: S): number

Inherited from Iter.indexOf
- Defined in iter/Iter.ts:133
Parameters
- value: S
Returns number

iter

iter(): Iter<S>

Inherited from Iter.iter
- Defined in iter/Iter.ts:32
Returns Iter<S>

join

join(separator?: string): string

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

last

last(): Option<S>

Inherited from Iter.last
- Defined in iter/Iter.ts:203
Returns Option<S>

map

map<B>(fn: IMapFn<S, B>): Map<S, B>

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

merge

merge(iter: Iterator<S, any, undefined>): Merge<S>

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

next

next(): IteratorResult<S, undefined>

Overrides Iter.next
- Defined in iter/Filter.ts:20
Returns IteratorResult<S, undefined>

nextWithIndex

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

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

none

none(fn: (value: S, index: number) => boolean): boolean

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

nth

nth(index?: number): Option<S>

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

peekable

peekable(): Peekable<S>

Inherited from Iter.peekable
- Defined in iter/Iter.ts:55
Returns Peekable<S>

reduce

reduce<C>(acc: C, fn: (acc: C, value: S, index: number) => C): C

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

reverse

reverse(): Iter<S>

Inherited from Iter.reverse
- Defined in iter/Iter.ts:261
Returns Iter<S>

skip

skip(skip: number): Skip<S>

Inherited from Iter.skip
- Defined in iter/Iter.ts:90
Parameters
- skip: number
Returns Skip<S>

some

some(fn: (value: S, index: number) => boolean): boolean

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

step

step(step: number): Step<S>

Inherited from Iter.step
- Defined in iter/Iter.ts:85
Parameters
- step: number
Returns Step<S>

take

take(count: number): Take<S>

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

toArray

toArray(): S[]

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

toMap

toMap<K, V>(keyFn?: IToMapFn<S, K>, valueFn?: IToMapFn<S, V>): ToMap<S, K, V>

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

unflatten

unflatten<U>(fn: UnflattenFn<S, U>): Unflatten<S, U>

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

Generated using TypeDoc