time-to-botec/squiggle/node_modules/@stdlib/assert/tools/array-function/docs/repl.txt
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

41 lines
1.0 KiB
Plaintext

{{alias}}( predicate )
Returns a function which tests if every element in an array passes a test
condition.
The predicate function should accept a single argument: an array element. If
the array element satisfies a test condition, the function should return
`true`; otherwise, the function should return `false`.
Given an input array, the returned function returns `true` if all elements
pass the test and `false` otherwise.
The returned function returns `false` if provided an empty array.
The returned function returns `false` is not provided an array.
Parameters
----------
predicate: Function
Function to apply.
Returns
-------
fcn: Function
Function which tests if every element in an array passes a test
condition.
Examples
--------
> var fcn = {{alias}}( {{alias:@stdlib/assert/is-odd}} );
> var arr = [ 1, 3, 5, 7 ];
> var bool = fcn( arr )
true
> arr = [ 3, 5, 8 ];
> bool = fcn( arr )
false
See Also
--------