time-to-botec/squiggle/node_modules/@stdlib/utils/every-by/docs/repl.txt

45 lines
1.1 KiB
Plaintext
Raw Normal View History

{{alias}}( collection, predicate[, thisArg ] )
Tests whether all elements in a collection pass a test implemented by a
predicate function.
The predicate function is provided three arguments:
- `value`: collection value
- `index`: collection index
- `collection`: the input collection
The function immediately returns upon encountering a non-truthy return
value.
If provided an empty collection, the function returns `true`.
Parameters
----------
collection: Array|TypedArray|Object
Input collection over which to iterate. If provided an object, the
object must be array-like (excluding strings and functions).
predicate: Function
The test function.
thisArg: any (optional)
Execution context.
Returns
-------
bool: boolean
The function returns `true` if the predicate function returns a truthy
value for all elements; otherwise, the function returns `false`.
Examples
--------
> function positive( v ) { return ( v > 0 ); };
> var arr = [ 1, 2, 3, 4 ];
> var bool = {{alias}}( arr, positive )
true
See Also
--------