Symbol.keyFor()

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2015.

La méthode Symbol.keyFor(sym) permet de récupérer la clé d'un symbole donné qui est partagé via le registre global des symboles.

Exemple interactif

const globalSym = Symbol.for("foo"); // Global symbol

console.log(Symbol.keyFor(globalSym));
// Expected output: "foo"

const localSym = Symbol(); // Local symbol

console.log(Symbol.keyFor(localSym));
// Expected output: undefined

console.log(Symbol.keyFor(Symbol.iterator));
// Expected output: undefined

Syntaxe

js
Symbol.keyFor(sym);

Paramètres

sym

Le symbole dont on souhaite connaître la clé. Ce paramètre est obligatoire.

Valeur de retour

Une chaîne de caractères qui représente la clé d'un symbole donné si celui-ci est trouvé dans le registre global ou undefined sinon.

Exemples

js
var symboleGlobal = Symbol.for("toto"); // on crée un symbole global
Symbol.keyFor(symboleGlobal); // "toto"

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

// les symboles connus ne sont pas dans le registre
// global
Symbol.keyFor(Symbol.iterator); // undefined

Spécifications

Specification
ECMAScript® 2025 Language Specification
# sec-symbol.keyfor

Compatibilité des navigateurs

Report problems with this compatibility data on GitHub
desktopmobileserver
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
Deno
Node.js
keyFor

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support

Voir aussi