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

Export assignment iterReplicate

• iterReplicate(iterator: Iterator, n: number): Iterator

• Returns an iterator which replicates each iterated value n times.

  Notes

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

  Parameters

  • iterator: Iterator

    input iterator

  • n: number

    number of times each iterated value is replicated

  Returns Iterator

  iterator

  Example

  var array2iterator = require( `@stdlib/array/to-iterator` );
  
  var src = array2iterator( [ 1, 2, 3, 4 ] );
  var iter = iterReplicate( src, 2 );
  
  var v = iter.next().value;
  // returns 1
  
  v = iter.next().value;
  // returns 1
  
  v = iter.next().value;
  // returns 2
  
  v = iter.next().value;
  // returns 2
  
  // ...