diff options
author | Minteck <contact@minteck.org> | 2022-10-18 08:59:09 +0200 |
---|---|---|
committer | Minteck <contact@minteck.org> | 2022-10-18 08:59:09 +0200 |
commit | 2c4ae43e688a9873e86211ea0e7aeb9ba770dd77 (patch) | |
tree | 17848d95522dab25d3cdeb9c4a6450e2a234861f /alarm/node_modules/@arr/every/readme.md | |
parent | 108525534c28013cfe1897c30e4565f9893f3766 (diff) | |
download | pluralconnect-2c4ae43e688a9873e86211ea0e7aeb9ba770dd77.tar.gz pluralconnect-2c4ae43e688a9873e86211ea0e7aeb9ba770dd77.tar.bz2 pluralconnect-2c4ae43e688a9873e86211ea0e7aeb9ba770dd77.zip |
Update
Diffstat (limited to 'alarm/node_modules/@arr/every/readme.md')
-rw-r--r-- | alarm/node_modules/@arr/every/readme.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/alarm/node_modules/@arr/every/readme.md b/alarm/node_modules/@arr/every/readme.md new file mode 100644 index 0000000..31cad87 --- /dev/null +++ b/alarm/node_modules/@arr/every/readme.md @@ -0,0 +1,45 @@ +# @arr/every + +> A tiny, faster alternative to native `Array.prototype.every` + +:warning: Unlike native, `@arr/every` does _not_ support the optional `thisArg` parameter! + +## Install + +``` +$ npm install --save @arr/every +``` + +## Usage + +```js +import every from '@arr/every'; + +const isBigEnough = val => val >= 10; + +every([12, 5, 8, 130, 44], isBigEnough); +//=> false +every([12, 54, 18, 130, 44], isBigEnough); +//=> true +``` + +## API + +### every(arr, callback) + +#### arr +Type: `Array`<br> +The array to iterate upon. + +#### callback(value[, index, array]) +Type: `Function`<br> +Function to test for each element, taking three arguments: + +* **value** (required) -- The current element being processed in the array. +* **index** (optional) -- The index of the current element being processed in the array. +* **array** (optional) -- The array `every` was called upon. + + +## License + +MIT © [Luke Edwards](http://lukeed.com) |