useSymbol
Custom hook for managing ES6 Symbols. Provides utilities to create unique symbols, manage a registry of symbols, and access well-known symbols.
Installation
npx sse-hooks add use-symbol
yarn dlx sse-hooks add use-symbol
pnpm dlx sse-hooks add use-symbol
deno run -A npm:sse-hooks add use-symbol
bunx sse-hooks add use-symbol
Usage
example.ts
import { useSymbol } from "./{hooks file}";
const { createSymbol, wellKnownSymbols } = useSymbol();
const myId = createSymbol("my-id");
console.log(wellKnownSymbols.iterator); // Symbol(Symbol.iterator)
API
Parameters
| Prop | Default | Type |
|---|
Returns
| Return Value | Default | Type |
|---|---|---|
return | - |
Hook return value |
Types Aliases
No specific type aliases defined for this component.
Changelog
31af5 — Refactor useBattery hook and remove utility functions
c165d — feat: enhance useRoleGuard and useSSR hooks with additional options and documentation
30da4 — feat: add new hooks and their metadata
2f161 — feat: add useConferenceSystem, useKbd, useMediaQuality, useNetworkInformation, usePortal, useRoleGuard, useScreenShare, useSymbol hooks