Skip to content

Return the index of the first element in the array that satisfies the provided testing function.

License

Notifications You must be signed in to change notification settings

Xotic750/find-index-x

Repository files navigation

Travis status Dependency status devDependency status npm version jsDelivr hits bettercodehub score Coverage Status

find-index-x

This method returns the index of the first element in the array that satisfies the provided testing function.

module.exportsnumber

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

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

About

Return the index of the first element in the array that satisfies the provided testing function.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published