@bemoje/arr-index-of-first-where
Return the index of the first element of an array where the callback returns true. Returns -1 if none do.
Version
Travis CI
Dependencies
Stats
Donate
Installation
npm install @bemoje/arr-index-of-first-where
npm install --save @bemoje/arr-index-of-first-where
npm install --save-dev @bemoje/arr-index-of-first-where
Usage
import arrIndexOfFirstWhere from '@bemoje/arr-index-of-first-where'
const arr = [1, 2, 3, 4, 5]
arrIndexOfFirstWhere(arr, (element) => {
return element >= 3
})
//=> 2
arrIndexOfFirstWhere(arr, (element) => {
return element >= 6
})
//=> -1
Tests
Uses Jest to test module functionality. Run tests to get coverage details.
npm run test
API
arrIndexOfFirstWhere
Return the index of the first element of an array where the callback returns true. Returns -1 if none do.
Parameters
Returns
any The first element to satisfy the condition
predicate
Type: Function
Parameters
-
element
any The current array element -
index
number The current index -
array
Array The array being itereated