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

Export assignment iterReject

• iterReject(iterator: Iterator, predicate: Predicate, thisArg?: any): Iterator

• Returns an iterator which rejects a provided iterator's values according to a predicate function.

  Notes

  • When invoked, the predicate function is provided two arguments:

    • value: iterated value
    • index: iteration index (zero-based)

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

  Parameters

  • iterator: Iterator

    input iterator

  • predicate: Predicate

    predicate function

  • Optional thisArg: any

    execution context

  Returns Iterator

  iterator

  Example

  var array2iterator = require( `@stdlib/array/to-iterator` );
  
  function predicate( v ) {
      return ( v > 2 );
  }
  
  var src = array2iterator( [ 1, 3, 2, 4 ] );
  var iter = iterReject( src, predicate );
  
  var v = iter.next().value;
  // returns 1
  
  v = iter.next().value;
  // returns 2
  
  var bool = iter.next().done;
  // returns true