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
  An iterable object or function. Array - return one element per cycle Object{next:Function} - call next() for the next value (this also handles generator functions) Function - call to return the next value
Returns Iterator
- Defined in src/lazy.ts:160

Methods

[iterator]

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

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:243

each

each<T = unknown>(f: Callback<T>): boolean
Execute the funcion for each value. Will stop when an execution returns false.
Type Parameters
- T = unknown
Parameters
- f: Callback<T>
Returns boolean
false iff f return false for AnyVal execution, otherwise true
- Defined in src/lazy.ts:285

filter

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

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:219

next

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

reduce

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

size

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

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

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:235

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:255

value

value<T>(): T[]
Returns the fully realized values of the iterators. The return value will be an array unless lazy.first() was used. The realized values are cached for subsequent calls.
Type Parameters
- T
Returns T[]
- Defined in src/lazy.ts:273