time-to-botec/js/node_modules/@stdlib/utils/some/README.md

some

Test whether a collection contains at least n elements which are truthy.

Usage

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

some( collection, n )

Tests whether a collection contains at least n elements which are truthy.

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

var bool = some( arr, 3 );
// returns true

If provided an empty collection, the function returns false.

var bool = some( [], 1 );
// 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 some = require( '@stdlib/utils/some' );

var bool;
var arr;
var i;

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

bool = some( arr, 5 );
// returns <boolean>