isSymbol

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

この関数はTypeScriptの型述語としても機能し、引数の型をsymbolに狭めます。

インターフェース

function isSymbol(value: unknown): value is symbol;

パラメータ

• value (unknown): 確認する値。

戻り値

(value is symbol): valueがシンボルであればtrueを返し、それ以外の場合はfalseを返します。

例

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

isSymbol(Symbol('a')); // true
isSymbol(Symbol.for('a')); // true
isSymbol(Symbol.iterator); // true

isSymbol(null); // false
isSymbol(undefined); // false
isSymbol('123'); // false
isSymbol(false); // false
isSymbol(123n); // false
isSymbol({}); // false
isSymbol([1, 2, 3]); // false