(u: unknown): u is symbolChecks whether a value is a symbol.
When to use
Use to validate unknown input before treating it as a JavaScript symbol.
Example (Checking for symbols)
import { Symbol } from "effect"
console.log(Symbol.isSymbol(globalThis.Symbol.for("a"))) // true
console.log(Symbol.isSymbol("a")) // falseguards
Source effect/Symbol.ts:311 lines
export const const isSymbol: (
u: unknown
) => u is symbol
Checks whether a value is a symbol.
When to use
Use to validate unknown input before treating it as a JavaScript symbol.
Example (Checking for symbols)
import { Symbol } from "effect"
console.log(Symbol.isSymbol(globalThis.Symbol.for("a"))) // true
console.log(Symbol.isSymbol("a")) // false
isSymbol: (u: unknownu: unknown) => u: unknownu is symbol = import predicatepredicate.function isSymbol(
input: unknown
): input is symbol
Checks whether a value is a symbol.
When to use
Use when you need a Predicate guard to narrow an unknown value to a
symbol.
Details
Uses typeof input === "symbol".
Example (Guarding symbols)
import { Predicate } from "effect"
const data: unknown = Symbol.for("id")
if (Predicate.isSymbol(data)) {
console.log(data.description)
}
isSymbol