WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

Symbol.for() — Symbole aus einem gemeinsamen Registry

Symbol.for(key) sucht anhand eines Zeichenfolgenschlüssels nach einem Symbol im globalen Registry. Es gibt das vorhandene Symbol zurück oder erstellt und registriert ein neues. So können unabhängige Codeteile denselben Symbol-Schlüssel erhalten.

Version: 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) ist eine statische Methode, die einen primitiven Wert vom Typ symbol zurückgibt. Sie sucht den angegebenen Zeichenfolgenschlüssel im globalen Symbol-Registry der Laufzeitumgebung. Ist der Schlüssel nicht vorhanden, erstellt sie ein Symbol und registriert es unter diesem Schlüssel. Der Schlüssel dient zugleich als Beschreibung des Symbols.

Anders als bei Symbol.for("cktis.status") erstellt jeder Aufruf von Symbol("cktis.status") ein eigenes Symbol: Gleiche Beschreibungen bedeuten nicht, dass die Symbole dieselbe Identität haben. Über das Registry lassen sich Symbole zwischen Dateien und zwischen Realms teilen, die dasselbe Registry verwenden. Es ist kein Mechanismus zur dauerhaften Datenspeicherung.

Verwende Präfixe wie cktis.status, um Namenskollisionen mit Bibliotheken zu verringern. Ein registriertes Symbol ist kein Geheimnis: Anderer Code, der den Schlüssel kennt, kann es abrufen. Symbol.keyFor(symbol) gibt den Schlüssel eines registrierten Symbols zurück, bei einem mit Symbol() erstellten Symbol dagegen undefined.

Das Beispiel liest eine Objekteigenschaft über ein Symbol aus, das erneut aus dem Registry abgerufen wurde. MDN gibt an, dass Symbol.for() seit September 2015 browserübergreifend verfügbar ist; die API ist nicht nur im Browser verfügbar.

Beispiele

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

Ergebnis

true
false
ready
cktis.status
undefined

Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.

Quellen