Symbol.toPrimitive

Das bekannte Symbol Symbol.toPrimitive.

Mit Hilfe der Symbol.toPrimitive-Eigenschaft (verwendet als Funktionswert) kann ein Objekt in einen primitiven Wert umgewandelt werden. Die Funktion wird mit einem String-Argument hint aufgerufen, das den bevorzugten Typ des resultierenden primitiven Wertes angibt. Das hint-Argument kann "number", "string" oder "default" sein.

Der "number"-Hinweis wird von numerischen Umwandlungs- Algorithmen verwendet. Der "string"-Hinweis wird vom String-Umwandlungs- Algorithmus verwendet. Der "default"-Hinweis wird vom primitiven Umwandlungs- Algorithmus verwendet. Der hint dient nur als schwaches Präferenzsignal, und die Implementierung kann ihn ignorieren (wie es Symbol.prototype[Symbol.toPrimitive]() tut). Die Sprache erzwingt keine Übereinstimmung zwischen dem hint und dem Ergebnis-Typ, obwohl [Symbol.toPrimitive]() einen primitiven Wert zurückgeben muss, sonst wird ein TypeError ausgelöst.

Objekte ohne die [Symbol.toPrimitive]-Eigenschaft werden in primitive Werte umgewandelt, indem die Methoden valueOf() und toString() in unterschiedlicher Reihenfolge aufgerufen werden, was im Abschnitt zur Typumwandlung näher erklärt wird. [Symbol.toPrimitive]() ermöglicht volle Kontrolle über den primitiven Umwandlungsprozess. Beispielsweise behandelt Date.prototype[Symbol.toPrimitive]() "default" so, als ob es "string" wäre, und ruft toString() anstelle von valueOf() auf. Symbol.prototype[Symbol.toPrimitive]() ignoriert den Hinweis und gibt immer ein Symbol zurück, was bedeutet, dass selbst in String-Kontexten Symbol.prototype.toString() nicht aufgerufen wird, und Symbol Objekte müssen stets explizit über String() in Strings umgewandelt werden.

Das folgende Beispiel beschreibt, wie die Symbol.toPrimitive-Eigenschaft den aus einem Objekt konvertierten primitiven Wert ändern kann.

// An object without Symbol.toPrimitive property.
const obj1 = {};
console.log(+obj1); // NaN
console.log(`${obj1}`); // "[object Object]"
console.log(obj1 + ""); // "[object Object]"

// An object with Symbol.toPrimitive property.
const obj2 = {
  [Symbol.toPrimitive](hint) {
    if (hint === "number") {
      return 10;
    }
    if (hint === "string") {
      return "hello";
    }
    return true;
  },
};
console.log(+obj2); // 10        — hint is "number"
console.log(`${obj2}`); // "hello"   — hint is "string"
console.log(obj2 + ""); // "true"    — hint is "default"

• Polyfill von Symbol.toPrimitive in core-js
• Date.prototype[Symbol.toPrimitive]()
• Symbol.prototype[Symbol.toPrimitive]()
• Object.prototype.toString()
• Object.prototype.valueOf()