Class Iterator

A lazy collection iterator yields a single value at a time upon request.

Index

Constructors

Methods

[iterator] drop each filter map next reduce size take transform value

Constructors

constructor

new Iterator(source: Source): Iterator
Parameters
- source: Source
Returns Iterator
- Defined in src/lazy.ts:78

Methods

[iterator]

"[iterator]"(): Iterator
Returns Iterator
- Defined in src/lazy.ts:236

drop

drop(n: number): Iterator
Drop a number of values from the sequence
Parameters
- n: number
  Number of items to drop greater than 0
Returns Iterator
- Defined in src/lazy.ts:155

each

each<T = unknown>(f: Callback<T>): boolean
Execute the callback for each value.
Type Parameters
- T = unknown
Parameters
- f: Callback<T>
  The callback function.
Returns boolean
Returns false if the callback returned false to break the loop, otherwise true.
- Defined in src/lazy.ts:195

filter

filter<T = unknown>(f: Predicate<T>): Iterator
Select only items matching the given predicate
Type Parameters
- T = unknown
Parameters
- f: Predicate<T>
Returns Iterator
- Defined in src/lazy.ts:139

map

map<T = unknown>(f: Callback<T>): Iterator
Transform each item in the sequence to a new value
Type Parameters
- T = unknown
Parameters
- f: Callback<T>
Returns Iterator
- Defined in src/lazy.ts:131

next

next<T = unknown>(): IteratorResult<T>
Type Parameters
- T = unknown
Returns IteratorResult<T>
- Defined in src/lazy.ts:121

reduce

reduce<T = unknown>(f: Callback<T>, initialValue?: T): T
Returns the reduction of sequence according the reducing function
Type Parameters
- T = unknown
Parameters
- f: Callback<T>
  The reducing function
- OptionalinitialValue: T
  The initial value
Returns T
- Defined in src/lazy.ts:210

size

size(): number
Returns the number of matched items in the sequence

Returns number
- Defined in src/lazy.ts:229

take

take(n: number): Iterator
Take given numbe for values from sequence
Parameters
- n: number
  A number greater than 0
Returns Iterator
- Defined in src/lazy.ts:147

transform

transform(fn: Callback<Source, unknown[]>): Iterator
Returns a new lazy object with results of the transformation The entire sequence is realized.
Parameters
- fn: Callback<Source, unknown[]>
  Tranform function of type (Array) => (Any)
Returns Iterator
- Defined in src/lazy.ts:167

value

value<T>(): T[]
Retrieves all remaining values from the lazy evaluation and returns them as an array. This method processes the underlying iterator until it is exhausted, storing the results in an internal buffer to ensure subsequent calls return the same data.
Type Parameters
- T
Returns T[]
- Defined in src/lazy.ts:181