Function isSymbol

Alias

isSymbol(value): value is symbol

Check whether a value is a symbol.

This function can also serve as a type predicate in TypeScript, narrowing the type of the argument to symbol.

Parameters

value: unknown
The value to check.

Returns value is symbol

Returns true if value is a symbol, else false.

Example

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