@stdlib/utils-some

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

some

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

Installation

npm install @stdlib/utils-some

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>

---

See Also

• @stdlib/utils-any: test whether at least one element in a collection is truthy.
• @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-by: test whether a collection contains at least n elements which pass a test implemented by a predicate function.

---

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.