File tree Expand file tree Collapse file tree
lib/node_modules/@stdlib/utils
every-by-right/docs/types Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -28,10 +28,13 @@ import { Collection } from '@stdlib/types/object';
2828* ## Notes
2929*
3030* - The predicate function is provided three arguments:
31+ *
3132* - `value`: collection value
3233* - `index`: collection index
3334* - `collection`: the input collection
35+ *
3436* - The function immediately returns upon encountering a truthy return value.
37+ *
3538* - If provided an empty collection, the function returns `false`.
3639*
3740* @param collection - input collection
Original file line number Diff line number Diff line change @@ -28,10 +28,13 @@ import { Collection } from '@stdlib/types/object';
2828* ## Notes
2929*
3030* - The predicate function is provided three arguments:
31+ *
3132* - `value`: collection value
3233* - `index`: collection index
3334* - `collection`: the input collection
35+ *
3436* - The function immediately returns upon encountering a truthy return value.
37+ *
3538* - If provided an empty collection, the function returns `false`.
3639*
3740* @param collection - input collection
Original file line number Diff line number Diff line change @@ -28,10 +28,13 @@ import { Collection } from '@stdlib/types/object';
2828* ## Notes
2929*
3030* - The predicate function is provided three arguments:
31+ *
3132* - `value`: collection value
3233* - `index`: collection index
3334* - `collection`: the input collection
35+ *
3436* - The function immediately returns upon encountering a non-truthy return value.
37+ *
3538* - If provided an empty collection, the function returns `true`.
3639*
3740* @param collection - input collection
Original file line number Diff line number Diff line change @@ -25,6 +25,15 @@ import { Collection } from '@stdlib/types/object';
2525/**
2626* Tests whether all elements in a collection pass a test implemented by a predicate function.
2727*
28+ * ## Notes
29+ *
30+ * - The predicate function is provided three arguments:
31+ * - `value`: collection value
32+ * - `index`: collection index
33+ * - `collection`: the input collection
34+ * - The function immediately returns upon encountering a non-truthy return value.
35+ * - If provided an empty collection, the function returns `true`.
36+ *
2837* @param collection - input collection
2938* @param predicate - test function
3039* @param thisArg - execution context
Original file line number Diff line number Diff line change @@ -28,10 +28,13 @@ import { Collection } from '@stdlib/types/object';
2828* ## Notes
2929*
3030* - The predicate function is provided three arguments:
31+ *
3132* - `value`: collection value
3233* - `index`: collection index
3334* - `collection`: the input collection
35+ *
3436* - The function immediately returns upon encountering a truthy return value.
37+ *
3538* - If provided an empty collection, the function returns `true`.
3639*
3740* @param collection - input collection
Original file line number Diff line number Diff line change @@ -28,9 +28,11 @@ import { Collection } from '@stdlib/types/object';
2828* ## Notes
2929*
3030* - The predicate function is provided three arguments:
31+ *
3132* - `value`: collection value
3233* - `index`: collection index
3334* - `collection`: the input collection
35+ *
3436* - The function immediately returns upon encountering a truthy return value.
3537* - If provided an empty collection, the function returns `true`.
3638*
You can’t perform that action at this time.
0 commit comments