findIndex

INFO

この関数は互換性のために es-toolkit/compat からのみインポートできます。代替可能なネイティブ JavaScript API があるか、まだ十分に最適化されていないためです。

es-toolkit/compat からこの関数をインポートすると、lodash と完全に同じように動作します。

配列から条件に合う最初の値のインデックスを返します。

条件は複数の方法で指定できます。

• 検査関数: 各要素に対して検査する関数を実行します。最初に true を返す値が選択されます。
• 部分オブジェクト: 与えられたオブジェクトと部分的に一致する最初の要素が選択されます。
• プロパティ-値ペア: 該当プロパティに対して値が一致する最初の要素が選択されます。
• プロパティ名: 該当プロパティに対して真と評価される値を持つ最初の要素が選択されます。

インターフェース

function findIndex<T>(arr: T[], doesMatch: (item: T, index: number, arr: T[]) => unknown, fromIndex?: number): number;
function findIndex<T>(arr: T[], doesMatch: Partial<T>, fromIndex?: number): number;
function findIndex<T>(arr: T[], doesMatch: [keyof T, unknown], fromIndex?: number): number;
function findIndex<T>(arr: T[], doesMatch: string, fromIndex?: number): number;

パラメータ

• arr (T[]): 検索する配列。

arr は ArrayLike<T> であるか、null または undefined である可能性があります

lodash と完全に互換性があるように、findIndex 関数は arr を次のように処理します。

• arr が ArrayLike<T> の場合、Array.from(...) を使用して配列に変換します。
• arr が null または undefined の場合、空の配列と見なされます。

• doesMatch:

  • 検査関数 ((item: T, index: number, arr: T[]) => unknown): 探している要素かどうかを返す関数。
  • 部分オブジェクト (Partial<T>): 一致させるプロパティと値を指定した部分オブジェクト。
  • プロパティ-値ペア ([keyof T, unknown]): 最初が一致させるプロパティ、2番目が一致させる値を表すタプル。
  • プロパティ名 (string): 真と評価される値を持っているか確認するプロパティ名。

• fromIndex (number): 検索を開始するインデックス。デフォルトは 0。

戻り値

(number): 与えられた条件を満たす最初の要素のインデックス。ない場合は -1。

例

import { findIndex } from 'es-toolkit/compat';

// 検査関数を使う場合
const items = [1, 2, 3, 4, 5];
const result = findIndex(items, item => item > 3);
console.log(result); // 3

// 部分オブジェクトを使う場合
const items = [
  { id: 1, name: 'Alice' },
  { id: 2, name: 'Bob' },
];
const result = findIndex(items, { name: 'Bob' });
console.log(result); // 0

// プロパティ-値ペアを使う場合
const items = [
  { id: 1, name: 'Alice' },
  { id: 2, name: 'Bob' },
];
const result = findIndex(items, ['name', 'Alice']);
console.log(result); // 0

// プロパティ名を使う場合
const items = [
  { id: 1, name: 'Alice' },
  { id: 2, name: 'Bob' },
];
const result = findIndex(items, 'name');
console.log(result); // 0