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

Export assignment iterHead

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

• Returns an iterator which returns the first n values of a provided iterator.

  Notes

  • If a provided iterator only generates m values and m is less than n, the returned iterator only returns m values.
  • If an environment supports Symbol.iterator and a provided iterator is iterable, the returned iterator is iterable.

  Parameters

  • iterator: Iterator

    input iterator

  • n: number

    number of values

  Returns Iterator

  iterator

  Example

  var randu = require( `@stdlib/random/iter/randu` );
  
  var iter = iterHead( randu(), 10 );
  
  var r = iter.next().value;
  // returns <number>
  
  r = iter.next().value;
  // returns <number>
  
  r = iter.next().value;
  // returns <number>
  
  // ...