filter

INFO

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

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

与えられた条件を満たす要素を持つ新しい配列を返します。

条件はいくつかの方法で指定できます。

• 検査関数: 各要素に対して検査する関数を実行します。条件に合う要素を選択します。
• 部分オブジェクト: 指定されたオブジェクトと部分的に一致する要素を選択します。
• プロパティ-値ペア: 指定されたプロパティに対してキーと値が一致する要素を選択します。
• プロパティ名: 指定されたプロパティ名が存在する要素を選択します。

インターフェース

function filter<T>(arr: T[], doesMatch: (item: T, index: number, arr: T[]) => unknown): T[];
function filter<T>(arr: T[], doesMatch: Partial<T>): T[];
function filter<T>(arr: T[], doesMatch: [keyof T, unknown]): T[];
function filter<T>(arr: T[], doesMatch: PropertyKey): T[];

function filter<T extends Record<string, unknown>>(
  object: T,
  doesMatch: (value: T[keyof T], key: keyof T, object: T) => unknown
): T[];
function filter<T extends Record<string, unknown>>(object: T, doesMatch: Partial<T[keyof T]>): T[];
function filter<T extends Record<string, unknown>>(object: T, doesMatch: [keyof T[keyof T], unknown]): T[];
function filter<T extends Record<string, unknown>>(object: T, doesMatch: PropertyKey): T[];

パラメータ

• arr (T[]) または object (T): 繰り返し処理する配列やオブジェクト。

arr は ArrayLike<T>、null または undefined になります

lodash と完全に互換性を保つため、filter 関数は arr を次のように処理します。

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

• doesMatch:

  • 配列の場合:

    • 検査関数 ((item: T, index: number, arr: T[]) => unknown): 各要素が条件を満たしているか確認する関数。
    • 部分オブジェクト (Partial<T>): 要素の属性と値が一致するか確認する部分オブジェクト。
    • プロパティ-値ペア ([keyof T, unknown]): 最初の要素が対象プロパティ、2番目が対象値を示すタプル。
    • プロパティ名 (PropertyKey): 特定の属性を持っているか確認するプロパティ名。

  • オブジェクトの場合:

    • 検査関数 ((value: T[keyof T], key: keyof T, object: T) => unknown): 各要素が条件を満たしているか確認する関数。
    • 部分値 (Partial<T[keyof T]>): 要素の属性と値が一致するか確認する部分オブジェクト。
    • プロパティ-値ペア ([keyof T[keyof T], unknown]): 最初の要素が対象プロパティ、2番目が対象値を示すタプル。
    • プロパティ名 (PropertyKey): 特定の属性を持っているか確認するプロパティ名。

戻り値

(T[]): 条件を満たす要素の配列。該当する要素がなければ ([])

例

配列の場合

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

// 検査関数を使う場合
filter([1, 2, 3], n => n % 2 === 0);
// => [2]

// 部分オブジェクトを使う場合
const arr = [
  { id: 1, name: 'Alice' },
  { id: 2, name: 'Bob' },
];
filter(arr, { name: 'Bob' });
// => [{ id: 2, name: 'Bob' }]

// プロパティ-値ペアを使う場合
const arr = [
  { id: 1, name: 'Alice' },
  { id: 2, name: 'Bob' },
];
filter(arr, ['name', 'Alice']);
// => [{ id: 1, name: 'Alice' }]

// プロパティ名を使う場合
const arr = [
  { id: 1, name: 'Alice' },
  { id: 2, name: 'Bob' },
  { id: 3, age: 28 },
];
filter(arr, 'name');
// => [{ id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }]

オブジェクトの場合

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

// 検査関数を使う場合
const obj = { a: 1, b: 2, c: 3 };
filter(obj, item => item > 2);
// => [3]

// 部分オブジェクトを使う場合
const obj = {
  a: { id: 1, name: 'Alice' },
  b: { id: 2, name: 'Bob' },
};
filter(obj, { name: 'Bob' });
// => [{ id: 2, name: 'Bob' }]

// プロパティ-値ペアを使う場合
const obj = {
  alice: { id: 1, name: 'Alice' },
  bob: { id: 2, name: 'Bob' },
};
filter(obj, ['name', 'Alice']);
// => [{ id: 1, name: 'Alice' }]

// プロパティ名を使う場合
const obj = {
  a: { id: 1, name: 'Alice' },
  b: { id: 2, name: 'Bob' },
  c: { id: 3, age: 28 },
};
filter(obj, 'name');
// => [{ id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }]