Checks whether an iterated value passes a test.
Checks whether an iterated value passes a test.
Checks whether an iterated value passes a test.
Returns an iterator which filters a provided iterator's values according to a predicate function.
When invoked, the predicate
function is provided two arguments:
value
: iterated valueindex
: iteration index (zero-based)If an environment supports Symbol.iterator
and a provided iterator is iterable, the returned iterator is iterable.
input iterator
predicate function
execution context
iterator
var array2iterator = require( `@stdlib/array/to-iterator` );
function predicate( v ) {
return ( v > 2 );
}
var src = array2iterator( [ 1, 3, 2, 4 ] );
var iter = iterFilter( src, predicate );
var v = iter.next().value;
// returns 3
v = iter.next().value;
// returns 4
var bool = iter.next().done;
// returns true
Checks whether an iterated value passes a test.
iterated value
iteration index
boolean indicating whether an iterated value passes a test