findIndexByProp()

Looks for the first index in an array whose given property matches the criteria.

This function is valid in v2.8.0 to v2.24.3. This function has been downloaded 68 times.

Parameters

{Array} array
Array to traverse.
{string} propName
Name of the property of each array item to inspect. If no such property exists for any array item that item will simply be skipped.
{*} tester
Criteria by which to test the property of each item in array. If this is a function it will be passed the value of the property and the return value will be coerced to a boolean to see if the property fits the criteria. If this is a regular expression it will be tested against the property to see if the property fits the criteria. Any other type of value will be checked to see if the property is this value to see if it fits the criteria.

Returns

{number}
The first index in array for which tester matches the specified property. If tester never matches any of the properties -1 will be returned.

Required Function

This function directly requires the following function which is included automatically:

  • findByProp()
    Looks for the first value in an array whose given property matches the criteria.

Requiring Function

This function is directly required by the following function:

  • findByProp()
    Looks for the first value in an array whose given property matches the criteria.