@stdlib/utils-async-any-by-right

v0.2.2

Published

4 months ago

Test whether at least one element in a collection passes a test implemented by a predicate function, iterating from right to left.

Downloads

anyByRightAsync

Test whether at least one element in a collection passes a test implemented by a predicate function, iterating from right to left.

Installation

npm install @stdlib/utils-async-any-by-right

Usage

var anyByRightAsync = require( '@stdlib/utils-async-any-by-right' );

anyByRightAsync( collection, [options,] predicate, done )

Tests whether at least one element in a collection passes a test implemented by a predicate function, iterating from right to left.

function predicate( value, next ) {
    setTimeout( onTimeout, value );
    function onTimeout() {
        console.log( value );
        /* =>
            1000
            2500
            3000
        */

        next( null, false );
    }
}

function done( error, bool ) {
    if ( error ) {
        throw error;
    }
    console.log( bool );
    // => false
}

var arr = [ 1000, 2500, 3000 ];

anyByRightAsync( arr, predicate, done );

If a predicate function calls the next callback with a truthy test argument, the function stops processing any additional collection elements and returns true for the test result.

function predicate( value, index, next ) {
    setTimeout( onTimeout, value );
    function onTimeout() {
        if ( index === 1 ) {
            return next( null, true );
        }
        next( null, false );
    }
}

function done( error, bool ) {
    if ( error ) {
        throw error;
    }
    console.log( bool );
    // => true
}

var arr = [ 1000, 2500, 3000 ];

anyByRightAsync( arr, predicate, done );

The function accepts the following options:

limit: the maximum number of pending invocations at any one time. Default: infinity.
series: boolean indicating whether to sequentially invoke the predicate function for each collection element. If true, the function sets options.limit=1. Default: false.
thisArg: the execution context for predicate.

By default, all elements are processed concurrently, which means that the function does not guarantee completion order. To process each collection element sequentially, set the series option to true.

function predicate( value, next ) {
    setTimeout( onTimeout, value );
    function onTimeout() {
        console.log( value );
        /* =>
            3000
            2500
            1000
        */
        next( null, false );
    }
}

function done( error, bool ) {
    if ( error ) {
        throw error;
    }
    console.log( bool );
    // => false
}

var arr = [ 1000, 2500, 3000 ];

var opts = {
    'series': true
};

anyByRightAsync( arr, opts, predicate, done );

To limit the maximum number of pending function invocations, set the limit option.

function predicate( value, next ) {
    setTimeout( onTimeout, value );
    function onTimeout() {
        console.log( value );
        /* =>
            2500
            3000
            1000
        */

        next( null, false );
    }
}

function done( error, bool ) {
    if ( error ) {
        throw error;
    }
    console.log( bool );
    // => false
}

var arr = [ 1000, 2500, 3000 ];

var opts = {
    'limit': 2
};

anyByRightAsync( arr, opts, predicate, done );

To set the execution context of the predicate function, set the thisArg option.

function predicate( value, next ) {
    this.count += 1;
    setTimeout( onTimeout, value );
    function onTimeout() {
        next( null, false );
    }
}

var arr = [ 1000, 2500, 3000 ];

var context = {
    'count': 0
};

var opts = {
    'thisArg': context
};

anyByRightAsync( arr, opts, predicate, done );

function done( error, bool ) {
    if ( error ) {
        throw error;
    }
    console.log( bool );
    // => false

    console.log( context.count );
    // => 3
}

When invoked, the predicate function is provided a maximum of four arguments:

value: collection value.
index: collection index.
collection: the input collection.
next: a callback which should be called once the predicate function has finished processing a collection value.

The actual number of provided arguments depends on function length. If the predicate function accepts two arguments, the predicate function is provided value and next. If the predicate function accepts three arguments, the predicate function is provided value, index, and next. For every other predicate function signature, the predicate function is provided all four arguments.

function predicate( value, i, collection, next ) {
    console.log( 'collection: %s. %d: %d', collection.join( ',' ), i, value );
    /* =>
        collection: 3000,2500,1000. 2: 3000
        collection: 3000,2500,1000. 1: 2500
        collection: 3000,2500,1000. 0: 1000
    */
    setTimeout( onTimeout, value );
    function onTimeout() {
        console.log( value );
        /* =>
            1000
            2500
            3000
        */

        next( null, false );
    }
}

function done( error, bool ) {
    if ( error ) {
        throw error;
    }
    console.log( bool );
    // => false
}

var arr = [ 1000, 2500, 3000 ];

anyByRightAsync( arr, predicate, done );

anyByRightAsync.factory( [options,] predicate )

Returns a function which invokes a predicate function once for each element in a collection, iterating from right to left.

function predicate( value, next ) {
    setTimeout( onTimeout, value );
    function onTimeout() {
        console.log( value );
        next( null, false );
    }
}

function done( error, bool ) {
    if ( error ) {
        throw error;
    }
    console.log( bool );
}

var f = anyByRightAsync.factory( predicate );

var arr1 = [ 1000, 2500, 3000 ];

f( arr1, done );
/* e.g., =>
    1000
    2500
    3000
    false
*/

var arr2 = [ 100, 250, 300 ];

f( arr2, done );
/* e.g., =>
    100
    250
    300
    false
*/

The function accepts the same options as anyByRightAsync().

Notes

A collection may be either an Array, Typed Array, or an array-like Object (excluding strings and functions).
If a provided function calls the next callback with a truthy error argument, the function suspends execution and immediately calls the done callback for subsequent error handling.
The function does not support dynamic collection resizing.
The function does not skip undefined elements.
If provided an empty collection, the function calls the done callback with false as the test result.
Neither anyByRightAsync nor the function returned by the factory method guarantee asynchronous execution. To guarantee asynchrony, wrap the done callback in a function which either executes at the end of the current stack (e.g., nextTick) or during a subsequent turn of the event loop (e.g., setImmediate, setTimeout).

Examples

var resolve = require( 'path' ).resolve;
var readFile = require( '@stdlib/fs-read-file' );
var anyByRightAsync = require( '@stdlib/utils-async-any-by-right' );

var files = [
    resolve( __dirname, 'package.json' ),
    resolve( __dirname, 'README.md' )
];

function done( error, bool ) {
    if ( error ) {
        throw error;
    }
    if ( bool ) {
        console.log( 'Successfully read at least one file.' );
    } else {
        console.log( 'Unable to read any files.' );
    }
}

function predicate( file, next ) {
    var opts = {
        'encoding': 'utf8'
    };
    readFile( file, opts, onFile );

    function onFile( error ) {
        if ( error ) {
            return next( null, false );
        }
        next( null, true );
    }
}

anyByRightAsync( files, predicate, done );

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

License

See LICENSE.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme