includes (Lodash 互換性)

Array.prototype.includesを使用してください

このincludes関数は、オブジェクトの走査とSameValueZero比較処理により、動作が遅くなります。配列の場合、JavaScriptのネイティブArray.prototype.includesメソッドの方が高速で標準化されています。

代わりに、より高速でモダンなArray.prototype.includesを使用してください。

配列、オブジェクト、または文字列に特定の値が含まれているかを確認します。

const hasValue = includes(collection, target, fromIndex);

参照

includes(collection, target, fromIndex)

配列、オブジェクト、文字列に特定の値が存在するかを確認したい場合はincludesを使用してください。SameValueZero方式で値を比較します。

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

// 配列で値を検索
includes([1, 2, 3], 2);
// Returns: true

// オブジェクトの値から検索
includes({ a: 1, b: 'a', c: NaN }, 'a');
// Returns: true

// 文字列で部分文字列を検索
includes('hello world', 'world');
// Returns: true

特定のインデックスから検索を開始できます。

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

// インデックス2から検索
includes([1, 2, 3, 2], 2, 2);
// Returns: true (インデックス3にあります)

// 負のインデックスは末尾から計算
includes([1, 2, 3], 2, -2);
// Returns: true

nullまたはundefinedは常にfalseを返します。

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

includes(null, 1); // false
includes(undefined, 1); // false

文字列で部分文字列を検索することもできます。

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

// 最初から検索
includes('hello', 'e');
// Returns: true

// 特定の位置から検索
includes('hello', 'e', 2);
// Returns: false (インデックス2以降に'e'はありません)

NaN値も正しく見つけることができます。

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

includes([1, 2, NaN], NaN);
// Returns: true

includes({ a: 1, b: NaN }, NaN);
// Returns: true

パラメータ

• collection (Array | Record<string, any> | string | null | undefined): 検索する配列、オブジェクト、または文字列です。
• target (any): 見つける値です。
• fromIndex (number, 選択): 検索を開始するインデックスです。負の値は末尾から計算します。デフォルトは0です。

戻り値

(boolean): 値が存在する場合はtrue、そうでない場合はfalseを返します。