find-index-x
v3.1.2
This method returns the index of the first element in the array that satisfies the provided testing function.
342/weekUpdated 3 years agoMITUnpacked: 274.0 KB
Published by Graham Fairweather
npm install find-index-x
title="Travis status">
alt="Travis status" height="18">
title="Dependency status">
alt="Dependency status" height="18"/>
title="devDependency status">
alt="devDependency status" height="18"/>
title="npm version">
alt="npm version" height="18">
title="jsDelivr hits"> alt="jsDelivr hits" height="18">
title="bettercodehub score"> alt="bettercodehub score" height="18">
title="Coverage Status">
alt="Coverage Status" height="18">
find-index-x
This method returns the index of the first element in the array that satisfies the provided testing function.
$3
Like findIndex, this method returns an index in the array, if an element
in the array satisfies the provided testing function. Otherwise -1 is returned.
Kind: Exported member
Returns: number - Returns index of positively tested element, otherwise -1.
Throws:
- TypeError If array is null or undefined-
- TypeError If callback is not a function.
| Param | Type | Description |
| --------- | --------------------- | ------------------------------------------------------------------------------------------------------- |
| array | Array | The array to search. |
| callback | function | Function to execute on each value in the array, taking three arguments: element, index and array. |
| [thisArg] | \* | Object to use as this when executing callback. |
Example
``js
import findIndex from 'find-index-x';
function isPrime(element, index, array) {
let start = 2;
while (start <= Math.sqrt(element)) {
if (element % start < 1) {
return false;
}
start += 1;
}
return element > 1;
}
console.log(findIndex([4, 6, 8, 12, 14], isPrime)); // -1, not found
console.log(findIndex([4, 6, 7, 12, 13], isPrime)); // 2
``