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

none

Test whether all elements in a collection are falsy.

Usage

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

none( collection )

Tests whether all elements in a collection are falsy.

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

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

If provided an empty collection, the function returns true.

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

var bool;
var arr;
var i;

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

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