iterFilter

Usage

var iterFilter = require( '@stdlib/iter/filter' );

iterFilter( iterator, predicate[, thisArg] )

Returns an iterator which filters the values of another iterator according to a predicate function.

var array2iterator = require( '@stdlib/array/to-iterator' );

function predicate( v ) {
    return ( v > 2 );
}

var it = iterFilter( array2iterator( [ 1, 3, 2, 4 ] ), predicate );
// returns <Object>

var v = it.next().value;
// returns 3

v = it.next().value;
// returns 4

var bool = it.next().done;
// returns true

The returned iterator protocol-compliant object has the following properties:

• next: function which returns an iterator protocol-compliant object containing the next iterated value (if one exists) assigned to a value property and a done property having a boolean value indicating whether the iterator is finished.
• return: function which closes an iterator and returns a single (optional) argument in an iterator protocol-compliant object.

The predicate function is provided two arguments:

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

var array2iterator = require( '@stdlib/array/to-iterator' );

function predicate( v, i ) {
    return ( i >= 2 );
}

var it = iterFilter( array2iterator( [ 3, 4, 1, 2 ] ), predicate );
// returns <Object>

var v = it.next().value;
// returns 1

v = it.next().value;
// returns 2

var bool = it.next().done;
// returns true

To set the predicate function execution context, provide a thisArg.

var array2iterator = require( '@stdlib/array/to-iterator' );

function predicate( v ) {
    this.count += 1;
    return ( v > 0 );
}

var ctx = {
    'count': 0
};

var it = iterFilter( array2iterator( [ 1, 2, 3, 4 ] ), predicate, ctx );
// returns <Object>

var v = it.next().value;
// returns 1

v = it.next().value;
// returns 2

v = it.next().value;
// returns 3

var count = ctx.count;
// returns 3