CKTIS / JavaScript
Symbol.for() — symboles issus d’un registre partagé
Symbol.for(key) recherche un symbole dans le registre global à partir d’une clé textuelle. La méthode renvoie le symbole existant ou en crée et enregistre un nouveau. Des parties de code indépendantes peuvent ainsi obtenir la même clé de propriété symbolique.
Version : ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support
Syntaxe
Symbol.for(key)Symbol.for(key) est une méthode statique qui renvoie une valeur primitive de type symbol. Elle recherche la clé textuelle fournie dans le registre global des symboles de l’environnement d’exécution. Si la clé est absente, elle crée un symbole et l’enregistre sous cette clé. La clé sert également de description au symbole.
Contrairement à Symbol.for("cktis.status"), chaque appel à Symbol("cktis.status") crée un symbole distinct : des descriptions identiques n’impliquent pas une identité identique. Le registre permet de partager des symboles entre des fichiers ainsi qu’entre des realms qui utilisent le même registre. Il ne s’agit pas d’un mécanisme de stockage persistant des données.
Utilisez des préfixes tels que cktis.status pour réduire les risques de collision de noms avec des bibliothèques. Un symbole enregistré n’est pas un secret : tout autre code connaissant la clé peut le récupérer. Symbol.keyFor(symbol) renvoie la clé d’un symbole enregistré, mais renvoie undefined pour un symbole créé avec Symbol().
L’exemple lit une propriété d’objet au moyen d’un symbole récupéré à nouveau dans le registre. MDN indique que Symbol.for() est disponible dans les navigateurs depuis septembre 2015 ; cette API n’est pas réservée aux navigateurs.
Exemples
const first = Symbol.for("cktis.status");
const second = Symbol.for("cktis.status");
const local = Symbol("cktis.status");
const record = { [first]: "ready" };
console.log(first === second);
console.log(first === local);
console.log(record[second]);
console.log(Symbol.keyFor(first));
console.log(Symbol.keyFor(local));Résultat
true false ready cktis.status undefined
Le code affiché et le résultat déclaré ont été vérifiés dans un environnement isolé selon la méthode consignée dans la preuve de vérification de cette version exacte.