Symbol

Beschreibung

Um ein neues primitives Symbol zu erstellen, schreiben Sie Symbol() mit einer optionalen Zeichenkette als dessen Beschreibung:

const sym1 = Symbol();
const sym2 = Symbol("foo");
const sym3 = Symbol("foo");

Der obige Code erstellt drei neue Symbole. Beachten Sie, dass Symbol("foo") die Zeichenkette "foo" nicht in ein Symbol umwandelt. Es erstellt jedes Mal ein neues Symbol:

Symbol("foo") === Symbol("foo"); // false

Die folgende Syntax mit dem new-Operator wird einen TypeError werfen:

const sym = new Symbol(); // TypeError

Dies verhindert, dass Autoren ein explizites Symbol-Wrapper-Objekt anstelle eines neuen Symbolwerts erstellen, und knnte berraschend sein, da das Erstellen expliziter Wrapper-Objekte fr primitive Datentypen generell mglich ist (z.B. new Boolean, new String und new Number).

Wenn Sie wirklich ein Symbol-Wrapper-Objekt erstellen mchten, knnen Sie die Funktion Object() verwenden:

const sym = Symbol("foo");
typeof sym; // "symbol"
const symObj = Object(sym);
typeof symObj; // "object"

Da Symbole der einzige primitive Datentyp sind, der Referenzidentitt hat (d.h. Sie knnen das gleiche Symbol nicht zweimal erstellen), verhalten sie sich in gewisser Weise wie Objekte. Zum Beispiel sind sie Mll sammelbar und knnen daher in WeakMap, WeakSet, WeakRef und FinalizationRegistry Objekten gespeichert werden.

Geteilte Symbole im globalen Symbolregister

Die obige Syntax mit der Symbol()-Funktion erzeugt ein Symbol, dessen Wert whrend der gesamten Programmlaufzeit einzigartig bleibt. Um Symbole zu erstellen, die ber Dateien und sogar ber Bereiche (von denen jeder seinen eigenen globalen Geltungsbereich hat) verfgbar sind, verwenden Sie die Methoden Symbol.for() und Symbol.keyFor(), um Symbole aus dem globalen Symbolregister zu setzen und abzurufen.

Beachten Sie, dass das "globale Symbolregister" nur ein fiktives Konzept ist und mglicherweise keiner internen Datenstruktur in der JavaScript-Engine entspricht und selbst wenn ein solches Register existiert, ist dessen Inhalt dem JavaScript-Code nicht zugnglich, auer ber die Methoden for() und keyFor().

Die Methode Symbol.for(tokenString) nimmt einen Zeichenfolgeschlssel und gibt einen Symbolwert aus dem Register zurck, whrend Symbol.keyFor(symbolValue) einen Symbolwert nimmt und den Zeichenfolgeschlssel zurckgibt, der diesem entspricht. Jede ist das Inverse der anderen, sodass das Folgende true ist:

Symbol.keyFor(Symbol.for("tokenString")) === "tokenString"; // true

Da registrierte Symbole berall arbitrr erstellt werden knnen, verhalten sie sich nahezu genau wie die Zeichenfolgen, die sie umhllen. Daher sind sie nicht garantiert einzigartig und knnen nicht Mll gesammelt werden. Daher sind registrierte Symbole in WeakMap, WeakSet, WeakRef und FinalizationRegistry Objekten nicht erlaubt.

Bekannt Symbole

Alle statischen Eigenschaften des Symbol-Konstruktors sind selbst Symbole, deren Werte im gesamten Geltungsbereichs konstant bleiben. Sie werden als bekannt Symbole bezeichnet, und ihr Zweck besteht darin, als "Protokolle" fr bestimmte eingebaute JavaScript-Operationen zu dienen, die es Benutzern ermglichen, das Verhalten der Sprache zu anzupassen. Wenn z.B. eine Konstruktionsfunktion eine Methode mit Symbol.hasInstance als Namen hat, wird diese Methode ihr Verhalten mit dem instanceof-Operator kodieren.

Vor den bekannt Symbolen verwendete JavaScript normale Eigenschaften, um bestimmte eingebauten Operationen zu implementieren. Zum Beispiel wird die Funktion JSON.stringify versuchen, die toJSON()-Methode jedes Objekts aufzurufen, und die String Funktion wird die toString()- und valueOf()-Methoden des Objekts aufrufen. Da jedoch immer mehr Operationen zur Sprache hinzugefgt werden, kann die Zuweisung einer "magischen Eigenschaft" fr jede Operation die Abwrtskompatibilitt brechen und das Verhalten der Sprache schwer nachvollziehbar machen. Bekannt Symbole ermglichen es, dass die Anpassungen fr normalen Code "unsichtbar" sind, der typischerweise nur Zeichenfolgeneigenschaften liest.

Bekannt Symbole haben nicht das Konzept der Mll sammelbarkeit, weil sie in einer festen Menge vorkommen und whrend der Programmlaufzeit einzigartig sind, hnlich wie intrinsische Objekte wie Array.prototype, daher sind sie auch in WeakMap, WeakSet, WeakRef und FinalizationRegistry Objekten erlaubt.

Finden von Symboleigenschaften auf Objekten

Die Methode Object.getOwnPropertySymbols() gibt ein Array von Symbolen zurck und lsst Sie Symboleigenschaften auf einem gegebenen Objekt finden. Beachten Sie, dass jedes Objekt mit keinen eigenen Symboleigenschaften initialisiert wird, sodass dieses Array leer ist, es sei denn, Sie haben Symboleigenschaften auf dem Objekt gesetzt.

Konstruktor

Symbol()

Gibt primitive Werte des Typs Symbol zurck. Wirft einen Fehler, wenn mit new aufgerufen.

Statische Eigenschaften

Die statischen Eigenschaften sind alle bekannt Symbole. In diesen Beschreibungen von Symbolen verwenden wir Ausdrcke wie "Symbol.hasInstance is a method determining", aber beachten Sie, dass dies auf die Semantik einer Methode eines Objekts verweist, die dieses Symbol als Methodenname hat (weil bekannt Symbole als "Protokolle" fungieren), und nicht den Wert des Symbols selbst beschreibt.

Symbol.asyncDispose

Eine Methode, die Ressourcen des Objekts asynchron freigibt, wenn das Objekt nicht mehr im Geltungsbereich ist. Wird bei der Deklaration await using verwendet.

Symbol.asyncIterator

Eine Methode, die den Standard-AsyncIterator fr ein Objekt zurckgibt. Wird von for await...of verwendet.

Symbol.dispose

Eine Methode, die Ressourcen des Objekts freigibt, wenn das Objekt nicht mehr im Geltungsbereich ist. Wird bei der Deklaration using verwendet.

Symbol.hasInstance

Eine Methode, die bestimmt, ob ein Konstruktorobjekt ein Objekt als seine Instanz erkennt. Wird von instanceof verwendet.

Symbol.isConcatSpreadable

Ein boolescher Wert, der angibt, ob ein Objekt in seine Array-Elemente aufgeteilt werden sollte. Wird von Array.prototype.concat() verwendet.

Symbol.iterator

Eine Methode, die den Standard-Iterator fr ein Objekt zurckgibt. Wird von for...of verwendet.

Symbol.match

Eine Methode, die gegen eine Zeichenkette matcht, wird auch verwendet, um festzustellen, ob ein Objekt als regulrer Ausdruck verwendet werden kann. Wird von String.prototype.match() verwendet.

Symbol.matchAll

Eine Methode, die einen Iterator zurckgibt, der die Matches des regulren Ausdrucks gegen eine Zeichenkette erzeugt. Wird von String.prototype.matchAll() verwendet.

Symbol.replace

Eine Methode, die bereinstimmende Teilzeichenfolg einer Zeichenfolge ersetzt. Wird von String.prototype.replace() verwendet.

Symbol.search

Eine Methode, die den Index in einer Zeichenfolge zurckgibt, der mit dem regulren Ausdruck bereinstimmt. Wird von String.prototype.search() verwendet.

Symbol.species

Eine Konstruktorfunktion, die verwendet wird, um abgeleitete Objekte zu erstellen.

Symbol.split

Eine Methode, die eine Zeichenkette an den Indizes teilt, die mit einem regulren Ausdruck bereinstimmen. Wird von String.prototype.split() verwendet.

Symbol.toPrimitive

Eine Methode, die ein Objekt in einen primitiven Wert umwandelt.

Symbol.toStringTag

Ein Zeichenfolgenwert, der fr die Standardbeschreibung eines Objekts verwendet wird. Wird von Object.prototype.toString() verwendet.

Symbol.unscopables

Ein Objektwert, dessen eigene und geerbte Eigenschaftsnamen von den with-Umgebungsbindungen des zugehrigen Objekts ausgeschlossen sind.

Statische Methoden

Symbol.for()

Sucht nach bestehenden registrierten Symbolen im globalen Symbolregister mit dem gegebenen key und gibt es zurck, wenn es gefunden wird. Andernfalls wird ein neues Symbol erstellt und mit key registriert.

Symbol.keyFor()

Ruft einen gemeinsamen Symbolschlssel aus dem globalen Symbolregister fr das gegebene Symbol ab.

Instanzeigenschaften

Diese Eigenschaften sind auf Symbol.prototype definiert und werden von allen Symbol-Instanzen geteilt.

Symbol.prototype.constructor

Die Konstruktionsfunktion, die das Instanzobjekt erstellt hat. Fr Symbol-Instanzen ist der Anfangswert der Symbol-Konstruktor.

Symbol.prototype.description

Eine schreibgeschtzte Zeichenfolge, die die Beschreibung des Symbols enthlt.

Symbol.prototype[Symbol.toStringTag]

Der Anfangswert der [Symbol.toStringTag] Eigenschaft ist die Zeichenfolge "Symbol". Diese Eigenschaft wird in Object.prototype.toString() verwendet. Da Symbol jedoch auch seine eigene toString()-Methode hat, wird diese Eigenschaft nicht verwendet, es sei denn, Sie rufen Object.prototype.toString.call() mit einem Symbol als thisArg auf.

Instanzmethoden

Symbol.prototype.toString()

Gibt eine Zeichenfolge zurck, die die Beschreibung des Symbols enthlt. berschreibt die Object.prototype.toString()-Methode.

Symbol.prototype.valueOf()

Gibt das Symbol zurck. berschreibt die Object.prototype.valueOf()-Methode.

Symbol.prototype[Symbol.toPrimitive]()

Gibt das Symbol zurck.

Beispiele

Verwendung des typeof Operators mit Symbolen

Der typeof Operator kann Ihnen helfen, Symbole zu identifizieren.

typeof Symbol() === "symbol";
typeof Symbol("foo") === "symbol";
typeof Symbol.iterator === "symbol";

Konvertierungen von Symboltypen

Einige Dinge, die Sie beachten sollten, wenn Sie mit Typkonvertierungen von Symbolen arbeiten.

• Wenn versucht wird, ein Symbol in eine Zahl zu konvertieren, wird ein TypeError ausgelst (z.B. +sym oder sym | 0).
• Bei Verwendung loser Gleichheit gibt Object(sym) == sym true zurck.
• Symbol("foo") + "bar" wirft einen TypeError (kann Symbol nicht in Zeichenfolge konvertieren). Dies verhindert, dass Sie z.B. stillschweigend einen neuen Zeichenfolgen-Eigenschaftsnamen aus einem Symbol erstellen.
• Die "sichere" String(sym)-Konvertierung funktioniert wie ein Aufruf von Symbol.prototype.toString() mit Symbolen, aber beachten Sie, dass new String(sym) einen Fehler wirft.

Symbole und for...in Iteration

Symbole sind in for...in Iterationen nicht enumerable. Auerdem wird Object.getOwnPropertyNames() keine Symboleigenschaften von Objekten zurckgeben. Sie knnen jedoch Object.getOwnPropertySymbols() verwenden, um diese zu erhalten.

const obj = {};

obj[Symbol("a")] = "a";
obj[Symbol.for("b")] = "b";
obj["c"] = "c";
obj.d = "d";

for (const i in obj) {
  console.log(i);
}
// "c" "d"

Symbole und JSON.stringify()

Durch JSON.stringify() werden symbolschlssel-Eigenschaften vollstndig ignoriert:

JSON.stringify({ [Symbol("foo")]: "foo" });
// '{}'

Fr weitere Details siehe JSON.stringify().

Symbol-Wrapper-Objekte als Eigenschaftenschlssel

Wenn ein Symbol-Wrapper-Objekt als Eigenschaftenschlssel verwendet wird, wird dieses Objekt in das umschlossene Symbol umgewandelt:

const sym = Symbol("foo");
const obj = { [sym]: 1 };
obj[sym]; // 1
obj[Object(sym)]; // still 1

Spezifikationen

Browser-Kompatibilitt

Siehe auch

• Polyfill von Symbol in core-js
• typeof
• JavaScript Datentypen und Datenstrukturen
• ES6 In Depth: Symbols auf hacks.mozilla.org (2015)