@stdlib/assert-tools-array-function
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    Array Function

    NPM version Build Status Coverage Status

    Return a function which tests if every element in an array passes a test condition.

    Installation

    npm install @stdlib/assert-tools-array-function

    Usage

    var arrayfcn = require( '@stdlib/assert-tools-array-function' );

    arrayfcn( predicate )

    Returns a function which tests if every element in an array passes a test condition. Given an input array, the function returns true if all elements pass the test and false otherwise.

    var isOdd = require( '@stdlib/assert-is-odd' );
    
    var arr1 = [ 1, 3, 5, 7 ];
    var arr2 = [ 3, 5, 8 ];
    
    var f = arrayfcn( isOdd );
    
    var bool = f( arr1 );
    // returns true
    
    bool = f( arr2 );
    // returns false

    Notes

    • The returned function will return false if not provided an array.
    • The returned function will return false if provided an empty array.
    • A predicate function should accept a single argument: an array element. If the array element satisfies a test condition, the predicate function should return true; otherwise, the predicate function should return false.

    Examples

    var isEven = require( '@stdlib/assert-is-even' );
    var arrayfcn = require( '@stdlib/assert-tools-array-function' );
    
    var arr1;
    var arr2;
    var bool;
    var f;
    var i;
    
    arr1 = new Array( 25 );
    for ( i = 0; i < arr1.length; i++ ) {
        arr1[ i ] = i;
    }
    
    arr2 = new Array( 25 );
    for ( i = 0; i < arr2.length; i++ ) {
        arr2[ i ] = 2 * i;
    }
    
    f = arrayfcn( isEven );
    
    bool = f( arr1 );
    // returns false
    
    bool = f( arr2 );
    // returns true

    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

    Chat


    License

    See LICENSE.

    Copyright

    Copyright © 2016-2022. The Stdlib Authors.

    Install

    npm i @stdlib/assert-tools-array-function

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    158,092

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    38.9 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser