【Node.js24.x】Array::findIndex()メソッドの使い方
findIndexメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
findIndexメソッドは、配列の中から、指定されたテスト条件を満たす最初の要素のインデックスを検索し、そのインデックスを返すメソッドです。
このメソッドは、配列の各要素に対して、引数として渡されるコールバック関数(テスト関数)を順番に実行します。コールバック関数は、現在の要素の値、その要素のインデックス、およびfindIndexが呼び出された配列自体を引数として受け取ります。
コールバック関数が真(true)を返した最初の要素が見つかった場合、findIndexメソッドはそのインデックスを返し、それ以降の検索は行いません。もし配列の最後まで検索しても条件を満たす要素が一つも見つからなかった場合は、-1が返されます。
このメソッドは、配列内に特定の条件を満たす要素がどこにあるかを知りたい場合に有用です。例えば、商品リストから在庫がゼロになった最初の商品を見つけたり、ユーザー情報の中から特定のIDを持つユーザーのインデックスを特定したりする際に利用できます。
構文(syntax)
1const array = [10, 20, 30, 40, 50]; 2const foundIndex = array.findIndex(element => element > 25);
引数(parameters)
callbackFn, thisArg
- callbackFn: number: 配列の各要素に対して実行するコールバック関数。要素の値、インデックス、配列自身を引数として受け取ります。この関数は、要素が見つかった場合に
trueを返す必要があります。 - thisArg: any: callbackFn が実行される際に
thisとして使用される値。
戻り値(return)
number
指定された条件に合致する要素が見つからなかった場合、その要素のインデックス(位置)を返します。要素が見つからなかった場合は、-1 を返します。