128 lines
2.9 KiB
Markdown
128 lines
2.9 KiB
Markdown
|
<!--
|
||
|
|
|
||
|
|
@license Apache-2.0
|
||
|
|
|
||
|
|
Copyright (c) 2018 The Stdlib Authors.
|
||
|
|
|
||
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||
|
|
you may not use this file except in compliance with the License.
|
||
|
|
You may obtain a copy of the License at
|
||
|
|
|
||
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
||
|
|
|
||
|
|
Unless required by applicable law or agreed to in writing, software
|
||
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
|
|
See the License for the specific language governing permissions and
|
||
|
|
limitations under the License.
|
||
|
|
|
||
|
|
-->
|
||
|
|
|
||
|
|
# any
|
||
|
|
|
||
|
|
> Test whether at least one element in a collection is truthy.
|
||
|
|
|
||
|
|
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
|
||
|
|
|
||
|
|
<section class="intro">
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.intro -->
|
||
|
|
|
||
|
|
<!-- Package usage documentation. -->
|
||
|
|
|
||
|
|
<section class="usage">
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var any = require( '@stdlib/utils/any' );
|
||
|
|
```
|
||
|
|
|
||
|
|
#### any( collection )
|
||
|
|
|
||
|
|
Tests whether at least one element in a `collection` is truthy.
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var arr = [ 0, 0, 0, 0, 1 ];
|
||
|
|
|
||
|
|
var bool = any( arr );
|
||
|
|
// returns true
|
||
|
|
```
|
||
|
|
|
||
|
|
If provided an empty `collection`, the function returns `false`.
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var bool = any( [] );
|
||
|
|
// returns false
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.usage -->
|
||
|
|
|
||
|
|
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
||
|
|
|
||
|
|
<section class="notes">
|
||
|
|
|
||
|
|
## Notes
|
||
|
|
|
||
|
|
- A `collection` may be either an [`Array`][mdn-array], [`Typed Array`][mdn-typed-array], or an array-like [`Object`][mdn-object] (excluding `strings` and `functions`).
|
||
|
|
- The function does **not** skip `undefined` elements and is thus not optimized for sparse collections.
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.notes -->
|
||
|
|
|
||
|
|
<!-- Package usage examples. -->
|
||
|
|
|
||
|
|
<section class="examples">
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
<!-- eslint no-undef: "error" -->
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
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>
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.examples -->
|
||
|
|
|
||
|
|
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
||
|
|
|
||
|
|
<section class="references">
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.references -->
|
||
|
|
|
||
|
|
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
||
|
|
|
||
|
|
<section class="links">
|
||
|
|
|
||
|
|
[mdn-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array
|
||
|
|
|
||
|
|
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
|
||
|
|
|
||
|
|
[mdn-object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.links -->
|