time-to-botec/squiggle/node_modules/@stdlib/utils/every/README.md
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

3.0 KiB

every

Test whether all elements in a collection are truthy.

Usage

var every = require( '@stdlib/utils/every' );

every( collection )

Tests whether all elements in a collection are truthy.

var arr = [ 1, 1, 1, 1, 1 ];

var bool = every( arr );
// returns true

If provided an empty collection, the function returns true.

var bool = every( [] );
// returns true

Notes

  • A collection may be either an Array, Typed Array, or an array-like Object (excluding strings and functions).
  • The function does not skip undefined elements and is thus not optimized for sparse collections.

Examples

var randu = require( '@stdlib/random/base/randu' );
var every = require( '@stdlib/utils/every' );

var bool;
var arr;
var i;

arr = new Array( 100 );
for ( i = 0; i < arr.length; i++ ) {
    arr[ i ] = ( randu() < 0.95 );
}

bool = every( arr );
// returns <boolean>