time-to-botec/squiggle/node_modules/@stdlib/utils/any/README.md

any

Test whether at least one element in a collection is truthy.

Usage

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

any( collection )

Tests whether at least one element in a collection is truthy.

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

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

If provided an empty collection, the function returns false.

var bool = any( [] );
// returns false

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 any = require( '@stdlib/utils/any' );

var bool;
var arr;
var i;

arr = [];
for ( i = 0; i < 100; i++ ) {
    arr.push( ( randu() > 0.95 ) );
}

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