8000 GitHub - stdlib-js/utils-none at 6cd3ca84e4a6fd774be860fbd853cd8c53d30fcc
[go: up one dir, main page]

Skip to content

stdlib-js/utils-none

Repository files navigation

none

NPM version Build Status Coverage Status

Test whether all elements in a collection are falsy.

Installation

npm install @stdlib/utils-none

Alternatively,

The branches.md file summarizes the available branches and displays a diagram illustrating their relationships.

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>

See Also


Notice

This 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.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2022. The Stdlib Authors.

0