Symbol.keyFor()

The Symbol.keyFor(sym) method retrieves a shared symbol key from the global symbol registry for the given symbol.

Syntax

Symbol.keyFor(sym);

Parameters

sym
Symbol, required. The symbol to find a key for.

Return value

A string representing the key for the given symbol if one is found on the global registry; otherwise, undefined.

Examples

Using keyFor()

var globalSym = Symbol.for('foo'); // create a new global symbol
Symbol.keyFor(globalSym); // "foo"

var localSym = Symbol();
Symbol.keyFor(localSym); // undefined

// well-known symbols are not symbols registered
// in the global symbol registry
Symbol.keyFor(Symbol.iterator) // undefined

Specifications

Browser compatibility

BCD tables only load in the browser

See also