isMap

値がMapかどうかを確認します。

const result = isMap(value);

参照

isMap(value)

値がMapインスタンスかどうかを確認したい場合はisMapを使用してください。instanceof演算子を使用してMapかどうかを検査します。

import { isMap } from 'es-toolkit/predicate';

// Mapインスタンス
const map = new Map([['key', 'value']]);
console.log(isMap(map)); // true

// Mapではない値
console.log(isMap(new Set())); // false
console.log(isMap(new WeakMap())); // false
console.log(isMap({})); // false
console.log(isMap([])); // false
console.log(isMap(null)); // false

TypeScriptでタイプガードとしても使用できます。

function processValue(value: unknown) {
  if (isMap(value)) {
    // ここでvalueはMap<any, any>型に絞り込まれます
    console.log(value.size);
    value.set('new-key', 'new-value');
  }
}

パラメータ

• value (unknown): Mapかどうか確認する値です。

戻り値

(value is Map<any, any>): 値がMapの場合はtrue、そうでない場合はfalseを返します。