KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / JavaScript

Symbol.for() — symbolen uit een gedeeld register

Symbol.for(key) zoekt met een tekenreekssleutel naar een symbool in het globale register. De methode retourneert het bestaande symbool of maakt een nieuw symbool en registreert het. Zo kunnen onafhankelijke stukken code dezelfde symbolische eigenschappensleutel verkrijgen.

Versie: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support

Syntax

Symbol.for(key)

Symbol.for(key) is een statische methode die een primitieve waarde van het type symbol retourneert. De methode zoekt de opgegeven tekenreekssleutel op in het globale symbolenregister van de runtimeomgeving. Als de sleutel ontbreekt, maakt ze een symbool en registreert dat onder die sleutel. De sleutel dient ook als beschrijving van het symbool.

In tegenstelling tot Symbol.for("cktis.status") maakt elke aanroep van Symbol("cktis.status") een afzonderlijk symbool: dezelfde beschrijving betekent niet dezelfde identiteit. Met het register kunnen symbolen worden gedeeld tussen bestanden en tussen realms die hetzelfde register delen. Het is geen mechanisme voor permanente gegevensopslag.

Gebruik voorvoegsels zoals cktis.status om naamconflicten met bibliotheken te beperken. Een geregistreerd symbool is geen geheim: andere code die de sleutel kent, kan het ophalen. Symbol.keyFor(symbol) retourneert de sleutel van een geregistreerd symbool, maar retourneert undefined voor een symbool dat met Symbol() is gemaakt.

Het voorbeeld leest een objecteigenschap via een symbool dat opnieuw uit het register is opgehaald. MDN vermeldt dat Symbol.for() sinds september 2015 in browsers beschikbaar is; deze API is niet uitsluitend voor browsers bedoeld.

Voorbeelden

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));

Resultaat

true
false
ready
cktis.status
undefined

De getoonde code en het opgegeven resultaat zijn in een geïsoleerde omgeving geverifieerd met de methode die in het verificatiebewijs voor exact deze versie is vastgelegd.

Bronnen