Get symbols

Hassle-free JS symbols. Like, lots of them.

get-symbols is a tiny package (< 1KB) that lets you easily create new symbols through object destructuring:

import symbols from "get-symbols";

let { foo, bar, baz } = symbols.new;
// console.log(foo, bar, baz); // Symbol(foo) Symbol(bar) Symbol(baz)

symbols.new will always create new symbols, even for the same name:

foo === symbols.new.foo; // false

If you'd rather reuse symbols with the same name, you can use symbols.known:

import symbols from "symbols";

let { foo, bar, baz } = symbols.known;
// foo, bar, baz are new symbols
// with descriptions "foo", "bar", "baz"

foo === symbols.known.foo; // true

You can import KNOWN_SYMBOLS to get the symbols registry:

import { KNOWN_SYMBOLS } from "symbols";

console.log(KNOWN_SYMBOLS); // { foo: Symbol(foo), bar: Symbol(bar), baz: Symbol(baz) }

Custom registries

You can create your own symbols registry by calling symbols.registry() that behaves like symbols.known:

import symbols from "symbols";

let registry = symbols.registry();

let { foo, bar, baz } = registry;

console.log(foo, bar, baz); // Symbol(foo) Symbol(bar) Symbol(baz)