Return a function which tests if every element in an array-like object passes a test condition.
npm install @stdlib/assert-tools-array-like-functionAlternatively,
- To load the package in a website via a
scripttag without installation and bundlers, use the ES Module available on theesmbranch. - If you are using Deno, visit the
denobranch. - For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the
umdbranch.
The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.
var arraylikefcn = require( '@stdlib/assert-tools-array-like-function' );Returns a function which tests if every element in an array-like object passes a test condition. Given an input array-like object, 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 = arraylikefcn( isOdd );
var bool = f( arr1 );
// returns true
bool = f( arr2 );
// returns false- The returned function will return
falseif not provided an array-like object. - The returned function will return
falseif provided an empty array-like object. - A
predicatefunction should accept a single argument: an element from an array-like object. If the element satisfies a test condition, thepredicatefunction should returntrue; otherwise, thepredicatefunction should returnfalse.
var isEven = require( '@stdlib/assert-is-even' );
var arraylikefcn = require( '@stdlib/assert-tools-array-like-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 = arraylikefcn( isEven );
bool = f( arr1 );
// returns false
bool = f( arr2 );
// returns trueThis 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.
See LICENSE.
Copyright © 2016-2023. The Stdlib Authors.
