@stdlib/utils-any v0.2.1

any

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

Installation

npm install @stdlib/utils-any

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>

See Also

• @stdlib/utils-any-by: test whether at least one element in a collection passes a test implemented by a predicate function.
• @stdlib/utils-every: test whether all elements in a collection are truthy.
• @stdlib/utils-for-each: invoke a function for each element in a collection.
• @stdlib/utils-none: test whether all elements in a collection are falsy.
• @stdlib/utils-some: test whether a collection contains at least n elements which are truthy.

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

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.