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

Export assignment iterDedupeBy

• iterDedupeBy(iterator: Iterator, fcn: Callback): Iterator
• iterDedupeBy(iterator: Iterator, limit: number, fcn: Callback): Iterator

• Returns an iterator which removes consecutive values that resolve to the same value according to a provided function.

  Notes

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

  Parameters

  • iterator: Iterator

    input iterator

  • fcn: Callback

    function indicating whether an iterated value is a "duplicate"

  Returns Iterator

  iterator

  Example

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

• Returns an iterator which removes consecutive values that resolve to the same value according to a provided function.

  Notes

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

  throws

  limit must be a positive integer

  Parameters

  • iterator: Iterator

    input iterator

  • limit: number

    number of allowed consecutive duplicates

  • fcn: Callback

    function indicating whether an iterated value is a "duplicate"

  Returns Iterator

  iterator

  Example

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