CKTIS / JavaScript
Symbol — eindeutige Werte und Eigenschaftsschlüssel
Symbol() erzeugt einen eindeutigen, unveränderlichen primitiven Wert, der als Eigenschaftsschlüssel eines Objekts dienen kann. Die Beschreibung bestimmt nicht die Identität eines Symbols; Symbol.for() ermöglicht stattdessen, ein Symbol über ein Register gemeinsam zu nutzen.
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()
Symbol(description)
Symbol.for(key)
Symbol.keyFor(symbol)Symbol(description) gibt einen neuen, eindeutigen primitiven Wert vom Typ symbol zurück, kein Objekt. Die optionale Beschreibung hilft dabei, das Symbol zu erkennen, ist aber nicht seine Identität: Zwei Aufrufe von Symbol("id") ergeben unterschiedliche Werte. new Symbol() löst einen TypeError aus.
Ein Symbol kann unabhängig von Zeichenfolgen als Eigenschaftsschlüssel dienen. { [first]: "internal" } erstellt eine Eigenschaft mit dem in first gespeicherten Wert als Schlüssel, und record[first] liest ihren Wert aus. Die Eigenschaft record.id hat einen anderen Schlüssel und kann ohne Konflikt daneben bestehen.
Symbol.for(key) sucht ein Symbol im globalen Register oder erstellt eines: Derselbe Zeichenfolgen-Schlüssel liefert dasselbe Symbol. Symbol.keyFor(symbol) gibt dessen Registerschlüssel zurück oder undefined, wenn das Symbol nicht registriert ist. Das unterscheidet sich davon, mit Symbol() ein neues Symbol zu erstellen.
Ein Symbolschlüssel bietet keine Privatsphäre: Er lässt sich mit Object.getOwnPropertySymbols() finden, wird von Object.keys() jedoch ausgelassen. Eingebaute Symbole wie Symbol.iterator bilden eine eigene Gruppe vordefinierter Schlüssel, die von Sprachprotokollen verwendet werden.
Beispiele
const first = Symbol("id");
const second = Symbol("id");
const record = { id: "public", [first]: "internal" };
console.log(typeof first);
console.log(first === second);
console.log(record.id);
console.log(record[first]);
console.log(Symbol.for("app.id") === Symbol.for("app.id"));
console.log(Symbol.keyFor(Symbol.for("app.id")));Ergebnis
symbol false public internal true app.id
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.