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

Export assignment iterFill

• iterFill(iterator: Iterator, value: any, begin?: undefined | number, end?: undefined | number): Iterator

• Returns an iterator which replaces all values from a provided iterator from a start index to an end index with a static value.

  Notes

  • If end exceeds the length of the provided iterator, the returned iterator replaces the subsequence of iterated values starting from begin until the last iterated value of the provided iterator.
  • If an environment supports Symbol.iterator, the returned iterator is iterable.

  Parameters

  • iterator: Iterator

    input iterator

  • value: any

    static (fill) value

  • Optional begin: undefined | number

    start iteration index (inclusive)

  • Optional end: undefined | number

    end iteration index (non-inclusive)

  Returns Iterator

  iterator

  Example

  var randu = require( `@stdlib/random/iter/randu` );
  
  var iter = iterFill( randu(), 3.14, 0, 2 );
  
  var r = iter.next().value;
  // returns 3.14
  
  r = iter.next().value;
  // returns 3.14
  
  r = iter.next().value;
  // returns <number>
  
  // ...