Class Filter<T, S>

Type Parameters

T
S extends T

Hierarchy

Iter<S>
- Filter

Index

Constructors

Properties

Constructors

constructor

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

Properties

`Protected` _index

_index: number = 0

`Protected` _iter

_iter: Iterator<S, any, undefined>

Methods

[iterator]

[iterator](): Iter<S>
Returns Iter<S>
Inherited from Iter.[iterator]
- Defined in Iter.ts:29

all

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

any

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

concat

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

consume

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

filter

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

find

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

findAll

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

findIndex

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

first

first(): Option<S>
Returns Option<S>
Inherited from Iter.first
- Defined in Iter.ts:214

flatten

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

forEach

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

indexOf

indexOf(value: S): number
Parameters
- value: S
Returns number
Inherited from Iter.indexOf
- Defined in Iter.ts:148

iter

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

map

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

merge

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

next

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

nextWithIndex

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

none

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

nth

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

peekable

peekable(): Peekable<S>
Returns Peekable<S>
Inherited from Iter.peekable
- Defined in Iter.ts:56

reduce

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

reverse

reverse(): Reverse<S>
Returns Reverse<S>
Inherited from Iter.reverse
- Defined in Iter.ts:119

skip

skip(skip: number): Skip<S>
Parameters
- skip: number
Returns Skip<S>
Inherited from Iter.skip
- Defined in Iter.ts:91

some

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

step

step(step: number): Step<S>
Parameters
- step: number
Returns Step<S>
Inherited from Iter.step
- Defined in Iter.ts:86

take

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

toArray

toArray(): S[]
Returns S[]
Inherited from Iter.toArray
- Defined in Iter.ts:137

toMap

toMap<K, V>(keyFn?: IToMapFn<S, K>, valueFn?: IToMapFn<S, V>): ToMap<S, K, V>
Type Parameters
- K extends string | number | symbol
- V
Parameters
- Optional keyFn: IToMapFn<S, K>
- Optional valueFn: IToMapFn<S, V>
Returns ToMap<S, K, V>
Inherited from Iter.toMap
- Defined in Iter.ts:101

unflatten

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

Generated using TypeDoc