Class Iterator

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

Hierarchy

Iterator

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Iterator(source: Source): Iterator

- Defined in src/lazy.ts:129
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

Properties

Private __buf

__buf: AnyVal[]

Private __done

__done: boolean

Private __first

__first: boolean

Private __iteratees

__iteratees: Iteratee[]

Private __next

__next: Callback<Value>

Methods

Private _push

_push(action: Action, value: AnyVal): this

- Defined in src/lazy.ts:185
Add an iteratee to this lazy sequence

Parameters
- action: Action
- value: AnyVal
Returns this

Private _validate

_validate(): void

- Defined in src/lazy.ts:176
Returns void

drop

drop(n: number): Iterator

- Defined in src/lazy.ts:231
Drop a number of values from the sequence

Parameters
- n: number
  
  Number of items to drop greater than 0
Returns Iterator

each

each(f: Callback<AnyVal>): boolean

- Defined in src/lazy.ts:284
Execute the funcion for each value. Will stop when an execution returns false.

Parameters
- f: Callback<AnyVal>
Returns boolean

false iff f return false for AnyVal execution, otherwise true

filter

filter(predicate: Predicate<AnyVal>): Iterator

- Defined in src/lazy.ts:215
Select only items matching the given predicate

Parameters
- predicate: Predicate<AnyVal>
Returns Iterator

first

first(): Iterator

- Defined in src/lazy.ts:259
Mark this lazy object to return only the first result on lazy.value(). No more iteratees or transformations can be added after this method is called.

Returns Iterator

map

map(f: Callback<AnyVal>): Iterator

- Defined in src/lazy.ts:207
Transform each item in the sequence to a new value

Parameters
- f: Callback<AnyVal>
Returns Iterator

next

next(): Value

- Defined in src/lazy.ts:197
Returns Value

reduce

reduce<T>(f: Callback<T>, initialValue: T): T

- Defined in src/lazy.ts:299
Returns the reduction of sequence according the reducing function

Type parameters
- T
Parameters
- f: Callback<T>
  
  a reducing function
- initialValue: T
Returns T

size

size(): number

- Defined in src/lazy.ts:320
Returns the number of matched items in the sequence

Returns number

take

take(n: number): Iterator

- Defined in src/lazy.ts:223
Take given numbe for values from sequence

Parameters
- n: number
  
  A number greater than 0
Returns Iterator

transform

transform(fn: Callback<Source>): Iterator

- Defined in src/lazy.ts:243
Returns a new lazy object with results of the transformation The entire sequence is realized.

Parameters
- fn: Callback<Source>
  
  Tranform function of type (Array) => (Any)
Returns Iterator

value

value(): AnyVal

- Defined in src/lazy.ts:272
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

Returns AnyVal

Generated using TypeDoc