each-arg
v1.1.3
Published
Iterates through arguments or any other array-like object starting from specific index.
Downloads
41
Maintainers
Readme
each-arg
Iterates through arguments or any other array-like object starting from a specific index.
Install
npm i each-arg
CDN
jsDelivr
<script src="https://cdn.jsdelivr.net/npm/each-arg@latest/dist/each-arg.umd.js">
for production...
<script src="https://cdn.jsdelivr.net/npm/each-arg@latest/dist/each-arg.umd.min.js">
unpkg
<script src="https://unpkg.com/each-arg@latest/dist/each-arg.umd.js">
for production...
<script src="https://unpkg.com/each-arg@latest/dist/each-arg.umd.min.js">
Reference
syntax
eachArg(arr, start, callback(value, index, ...extra): any, ...extra): void;
Iterates over the array
, string
or array-like
arr
starting from the start
index. The callback
function will be called for every value
in the array, with the value
itself, the index
of the current item and any extra
argument passed to eachArg
function.
If a negative start
index is provided the iteration will start from X
number of items counting from the last item in the input array-like.
If the callback
returns a truthy value the iteration will stop.
Any extra
argument passed to eachArg
function will be passed down to the callback
function.
The callback
function inherits the this
value form the eachArg
function call. If you need a specific value inside the callback
, call eachArg
using it's call
method.
eachArg.call(thisArg, arr, start, callback, ..extra);
example
import eachArg from "each-arg";
eachArg([1, 2, 3, 4, 5], 1, (value, index, num) => {
console.log(value + " >> " + (index + num));
return index === 3;
}, 100);
2 >> 101
3 >> 102
4 >> 103
Usage
Node.js
const eachArg = require("each-arg");
eachArg(args, start, callback);
Browser
After adding the script
tag, eachArg
function will be available globally through eachArg
or window.eachArg
.
eachArg(args, start, callback);