js-util

Home > rc-js-util > ATypedArrayTuple > findIndex

ATypedArrayTuple.findIndex() method

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Signature:

findIndex(_predicate: (value: number, index: TExtractIndexes<this>, obj: this) => boolean, _thisArg?: unknown): number;

Parameters

Parameter Type Description
_predicate (value: number, index: TExtractIndexes<this>, obj: this) => boolean find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
_thisArg unknown (Optional) If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns:

number