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

Export assignment iterDatespace

• iterDatespace(start: number | string | Date, stop: number | string | Date, N?: undefined | number, options?: Options): Iterator
• iterDatespace(start: number | string | Date, stop: number | string | Date, options?: Options): Iterator

• Returns an iterator which returns evenly spaced dates over a specified interval.

  Notes

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

  throws

  a numeric start argument must be a nonnegative integer

  throws

  a numeric stop argument must be a nonnegative integer

  throws

  unable to parse date string

  throws

  N must be a nonnegative integer

  throws

  must provide valid options

  Parameters

  • start: number | string | Date

    starting date as either a Date object, JavaScript timestamp, or a date string (inclusive)

  • stop: number | string | Date

    stopping date as either a Date object, JavaScript timestamp, or a date string (inclusive)

  • Optional N: undefined | number

    number of values (default: 100)

  • Optional options: Options

    function options

  Returns Iterator

  iterator

  Example

  var start = new Date();
  var iter = iterDatespace( start, new Date( start.getTime()+86400000 ), 100 );
  
  var v = iter.next().value;
  // returns <Date>
  
  v = iter.next().value;
  // returns <Date>
  
  v = iter.next().value;
  // returns 2
  
  // ...

• Returns an iterator which returns evenly spaced dates over a specified interval.

  Notes

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

  throws

  a numeric start argument must be a nonnegative integer

  throws

  a numeric stop argument must be a nonnegative integer

  throws

  unable to parse date string

  throws

  must provide valid options

  Parameters

  • start: number | string | Date

    starting date as either a Date object, JavaScript timestamp, or a date string (inclusive)

  • stop: number | string | Date

    stopping date as either a Date object, JavaScript timestamp, or a date string (inclusive)

  • Optional options: Options

    function options

  Returns Iterator

  iterator

  Example

  var start = new Date();
  var iter = iterDatespace( start, new Date( start.getTime()+86400001 ), {
      'round': 'floor'
  });
  
  var v = iter.next().value;
  // returns <Date>
  
  v = iter.next().value;
  // returns <Date>
  
  v = iter.next().value;
  // returns <Date>
  
  // ...