Array.prototype.findIndex()

callbackFn

配列のそれぞれの要素に対して実行する関数です。一致する要素が得られたことを示すには真値を返し、そうでなければ偽値を返してください。この関数は以下の引数で呼び出されます。

element

配列内で現在処理されている要素です。

index

配列内で現在処理されている要素のインデックス（位置）です。

array

findIndex() を呼び出した元の配列です。

thisArg 省略可

callbackFn 内で this として使われるオブジェクトです。反復処理メソッドを参照してください。

テストに合格した配列の要素の位置を返します。それ以外の場合は、 -1 を返します。

findIndex() メソッドは反復処理メソッドです。配列の要素のそれぞれに対して、インデックスの昇順に一度ずつ callbackFn 関数を実行し、callbackFn 関数が真値を返すまで繰り返します。 findIndex() はその要素を返し、配列の反復処理を停止します。もし callbackFn が真値を返さない場合、 findIndex() は -1 を返します。

callbackFn は、値が割り当てられているものに限らず、配列中のすべてのインデックスに対して呼び出されます。疎配列では、空のスロットは undefined と同じ動作をします。

findIndex() は、呼び出した配列を変更 (mutate) しませんが、callbackFn で提供された関数は変更する可能性があります。しかし、配列の長さは最初に callbackFn が呼び出される前に設定されます。したがって、

• callbackFn は findIndex() の呼び出しを始めたときの配列の長さを超えて追加された要素にはアクセスしません。
• 既に訪問した位置を変更しても、 callbackFn が再度呼び出されることはありません。
• まだ訪問していない既存の配列要素が callbackFn によって変更された場合、 callbackFn に渡される値はその要素が取得される時点の値になります。削除された 要素は undefined であるかのように処理されます。

findIndex() メソッドは汎用的です。これは this 値に length プロパティと整数キーのプロパティがあることだけを期待します。

次の例では、配列の中で素数の入った最初の要素の位置を返し、素数が見つからなかった場合は -1 を返します。

function isPrime(element) {
  if (element % 2 === 0 || element < 2) {
    return false;
  }
  for (let factor = 3; factor <= Math.sqrt(element); factor += 2) {
    if (element % factor === 0) {
      return false;
    }
  }
  return true;
}

console.log([4, 6, 8, 9, 12].findIndex(isPrime)); // -1, not found
console.log([4, 6, 7, 9, 12].findIndex(isPrime)); // 2 (array[2] is 7)

疎配列で undefined を検索することで、空スロットのインデックスを取得することができます。

console.log([1, , 3].findIndex((x) => x === undefined)); // 1

findIndex() メソッドは this の length プロパティを読み込み、そのキーが length よりも小さい非負の整数である各プロパティにアクセスします。

const arrayLike = {
  length: 3,
  "-1": 0.1, // -1 < 0 なので findIndex() 空は無視される
  0: 2,
  1: 7.3,
  2: 4,
};
console.log(
  Array.prototype.findIndex.call(arrayLike, (x) => !Number.isInteger(x)),
); // 1

• Array.prototype.findIndex のポリフィル (core-js)
• インデックス付きコレクションのガイド
• Array
• Array.prototype.find()
• Array.prototype.findLast()
• Array.prototype.findLastIndex()
• Array.prototype.indexOf()
• Array.prototype.lastIndexOf()
• TypedArray.prototype.findIndex()