Function: isSymbol()

isSymbol(val): val is symbol

Type guard to check if a value is a symbol.

Parameters

val

unknown

The value to check

Returns

val is symbol

True if the value is a symbol

Example

const value: unknown = Symbol('test')

if (isSymbol(value)) {
  // TypeScript knows value is a symbol
  console.log(value.toString()) // 'Symbol(test)'
}