Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stdlib-js/utils-every
Test whether all elements in a collection are truthy.
https://github.com/stdlib-js/utils-every
all array-like collection every iterate javascript node node-js nodejs stdlib test util utilities utility utils validate
Last synced: 13 days ago
JSON representation
Test whether all elements in a collection are truthy.
- Host: GitHub
- URL: https://github.com/stdlib-js/utils-every
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-14T13:35:15.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-29T12:08:32.000Z (5 months ago)
- Last Synced: 2024-12-06T05:09:29.188Z (28 days ago)
- Topics: all, array-like, collection, every, iterate, javascript, node, node-js, nodejs, stdlib, test, util, utilities, utility, utils, validate
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 929 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
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!
# every
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Test whether all elements in a collection are truthy.
## Installation
```bash
npm install @stdlib/utils-every
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var every = require( '@stdlib/utils-every' );
```
#### every( collection )
Tests whether all elements in a `collection` are truthy.
```javascript
var arr = [ 1, 1, 1, 1, 1 ];
var bool = every( arr );
// returns true
```
If provided an empty `collection`, the function returns `true`.
```javascript
var bool = every( [] );
// returns true
```
## 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.
## Examples
```javascript
var randu = require( '@stdlib/random-base-randu' );
var every = require( '@stdlib/utils-every' );
var bool;
var arr;
var i;
arr = new Array( 100 );
for ( i = 0; i < arr.length; i++ ) {
arr[ i ] = ( randu() < 0.95 );
}
bool = every( arr );
// returns
```
* * *
## See Also
- [`@stdlib/utils-any`][@stdlib/utils/any]: test whether at least one element in a collection is truthy.
- [`@stdlib/utils-every-by`][@stdlib/utils/every-by]: test whether all elements in a collection pass a test implemented by a predicate function.
- [`@stdlib/utils-for-each`][@stdlib/utils/for-each]: invoke a function for each element in a collection.
- [`@stdlib/utils-none`][@stdlib/utils/none]: test whether all elements in a collection are falsy.
- [`@stdlib/utils-some`][@stdlib/utils/some]: test whether a collection contains at least `n` elements which are truthy.
* * *
## Notice
This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/utils-every.svg
[npm-url]: https://npmjs.org/package/@stdlib/utils-every
[test-image]: https://github.com/stdlib-js/utils-every/actions/workflows/test.yml/badge.svg?branch=v0.2.2
[test-url]: https://github.com/stdlib-js/utils-every/actions/workflows/test.yml?query=branch:v0.2.2
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-every/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/utils-every?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/utils-every/tree/deno
[deno-readme]: https://github.com/stdlib-js/utils-every/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/utils-every/tree/umd
[umd-readme]: https://github.com/stdlib-js/utils-every/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/utils-every/tree/esm
[esm-readme]: https://github.com/stdlib-js/utils-every/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/utils-every/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-every/main/LICENSE
[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
[@stdlib/utils/any]: https://github.com/stdlib-js/utils-any
[@stdlib/utils/every-by]: https://github.com/stdlib-js/utils-every-by
[@stdlib/utils/for-each]: https://github.com/stdlib-js/utils-for-each
[@stdlib/utils/none]: https://github.com/stdlib-js/utils-none
[@stdlib/utils/some]: https://github.com/stdlib-js/utils-some