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

Export assignment iterStep

• iterStep(start: number, increment: number, N?: undefined | number): Iterator

• Returns an iterator which returns a sequence of numbers according to a provided increment.

  Notes

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

  Parameters

  • start: number

    starting value (inclusive)

  • increment: number

    increment

  • Optional N: undefined | number

    number of values (default: 1e308)

  Returns Iterator

  iterator

  Example

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