Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "iter/incrspace/docs/types/index.d"

Index

Type aliases

Functions

Type aliases

Iterator

Iterator: Iter | IterableIterator

Functions

Export assignment iterIncrspace

  • iterIncrspace(start: number, stop: number, increment?: undefined | number): Iterator
  • Returns an iterator which returns evenly spaced numbers according to a provided increment.

    Notes

    • If an environment supports Symbol.iterator, the returned iterator is iterable.

    Parameters

    • start: number

      starting value (inclusive)

    • stop: number

      stopping value (exclusive)

    • Optional increment: undefined | number

      increment (default: 1)

    Returns Iterator

    iterator

    Example

    var iter = iterIncrspace( 0, 100, 2 );
    
    var v = iter.next().value;
    // returns 0
    
    v = iter.next().value;
    // returns 2
    
    v = iter.next().value;
    // returns 4
    
    // ...