https://github.com/stdlib-js/assert-tools-array-function
Return a function which tests if every element in an array passes a test condition.
https://github.com/stdlib-js/assert-tools-array-function
apply array assert check function is javascript node node-js nodejs stdlib test tool tools valid validate
Last synced: 8 months ago
JSON representation
Return a function which tests if every element in an array passes a test condition.
- Host: GitHub
- URL: https://github.com/stdlib-js/assert-tools-array-function
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-13T19:23:47.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-01T02:24:11.000Z (about 1 year ago)
- Last Synced: 2024-11-11T07:35:23.549Z (about 1 year ago)
- Topics: apply, array, assert, check, function, is, javascript, node, node-js, nodejs, stdlib, test, tool, tools, valid, validate
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 845 KB
- Stars: 2
- Watchers: 4
- 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!
# Array Function
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Return a function which tests if every element in an array passes a test condition.
## Installation
```bash
npm install @stdlib/assert-tools-array-function
```
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 arrayfcn = require( '@stdlib/assert-tools-array-function' );
```
#### arrayfcn( predicate )
Returns a function which tests if every element in an [`array`][mdn-array] passes a test condition. Given an input [`array`][mdn-array], the function returns `true` if all elements pass the test and `false` otherwise.
```javascript
var isOdd = require( '@stdlib/assert-is-odd' );
var arr1 = [ 1, 3, 5, 7 ];
var arr2 = [ 3, 5, 8 ];
var f = arrayfcn( isOdd );
var bool = f( arr1 );
// returns true
bool = f( arr2 );
// returns false
```
## Notes
- The returned function will return `false` if **not** provided an [`array`][mdn-array].
- The returned function will return `false` if provided an empty [`array`][mdn-array].
- A `predicate` function should accept a single argument: an [`array`][mdn-array] element. If the [`array`][mdn-array] element satisfies a test condition, the `predicate` function should return `true`; otherwise, the `predicate` function should return `false`.
## Examples
```javascript
var isEven = require( '@stdlib/assert-is-even' );
var arrayfcn = require( '@stdlib/assert-tools-array-function' );
var arr1;
var arr2;
var bool;
var f;
var i;
arr1 = new Array( 25 );
for ( i = 0; i < arr1.length; i++ ) {
arr1[ i ] = i;
}
arr2 = new Array( 25 );
for ( i = 0; i < arr2.length; i++ ) {
arr2[ i ] = 2 * i;
}
f = arrayfcn( isEven );
bool = f( arr1 );
// returns false
bool = f( arr2 );
// returns true
```
* * *
## 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-2025. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/assert-tools-array-function.svg
[npm-url]: https://npmjs.org/package/@stdlib/assert-tools-array-function
[test-image]: https://github.com/stdlib-js/assert-tools-array-function/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/assert-tools-array-function/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/assert-tools-array-function/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/assert-tools-array-function?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/assert-tools-array-function/tree/deno
[deno-readme]: https://github.com/stdlib-js/assert-tools-array-function/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/assert-tools-array-function/tree/umd
[umd-readme]: https://github.com/stdlib-js/assert-tools-array-function/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/assert-tools-array-function/tree/esm
[esm-readme]: https://github.com/stdlib-js/assert-tools-array-function/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/assert-tools-array-function/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/assert-tools-array-function/main/LICENSE
[mdn-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array