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

Export assignment iterUnique

• iterUnique(iterator: Iterator): Iterator

• Returns an iterator which returns unique values.

  Notes

  • Value "uniqueness" is determined according to strict equality.
  • A returned iterator internally buffers unique values and, thus, has O(N) memory requirements.
  • If an environment supports Symbol.iterator and a provided iterator is iterable, the returned iterator is iterable.

  Parameters

  • iterator: Iterator

    input iterator

  Returns Iterator

  iterator

  Example

  var array2iterator = require( `@stdlib/array/to-iterator` );
  
  var iter = iterUnique( array2iterator( [ 1, 2, 1, 2, 4 ] ) );
  
  var v = iter.next().value;
  // returns 1
  
  v = iter.next().value;
  // returns 2
  
  v = iter.next().value;
  // returns 4
  
  var bool = iter.next().done;
  // returns true