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

Export assignment iterDedupe

• iterDedupe(iterator: Iterator, limit?: undefined | number): Iterator

• Returns an iterator which removes consecutive duplicated values.

  Notes

  • NaN values are considered distinct.
  • Uniqueness is determined according to strict equality. Accordingly, objects are not checked for deep equality.
  • If an environment supports Symbol.iterator and a provided iterator is iterable, the returned iterator is iterable.

  throws

  second argument must be a positive integer

  Parameters

  • iterator: Iterator

    input iterator

  • Optional limit: undefined | number

    number of allowed consecutive duplicates (default: 1)

  Returns Iterator

  iterator

  Example

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