Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / JavaScript

Symbol.toPrimitive — vlastní převod objektu na primitivní hodnotu

Symbol.toPrimitive je známý symbol označující metodu pro převod objektu na primitivní hodnotu. Metoda dostává nápovědu "string", "number" nebo "default" a má přednost před běžným použitím valueOf() a toString().

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

Syntaxe

const value = { [Symbol.toPrimitive](hint) { return hint === "string" ? "label" : 10; } };

Symbol.toPrimitive je symbol používaný jako klíč metody, nikoli převodní funkce. Definujte [Symbol.toPrimitive](hint) { ... }, chcete-li řídit převod objektu na primitivní hodnotu. Metoda se volá s převáděným objektem jako this.

Argument hint má hodnotu "string" pro String(obj), "number" pro Number(obj) a "default" při sčítání v obj + 3. Nápověda nevynucuje typ výsledku: metoda musí vrátit primitivní hodnotu, kterou může okolní operace dále převést. Vrácení objektu vyvolá TypeError, aniž by se zkoušely valueOf() nebo toString().

Pokud má vlastnost hodnotu undefined nebo null, použije se běžný převod: při řetězcové nápovědě se nejprve zkouší toString() a potom valueOf(); při číselné nápovědě je pořadí opačné. Bez nápovědy běžný převod upřednostňuje číslo. Jakákoli jiná nevolatelná hodnota vlastnosti vyvolá TypeError.

V příkladu vrátí String(amount) hodnotu Amount(7), Number(amount) hodnotu 7 a amount + 3 hodnotu 10. Se všemi třemi nápovědami zacházejte záměrně, abyste předešli překvapivým výsledkům operátoru +.

Příklady

const amount = {
  value: 7,
  [Symbol.toPrimitive](hint) {
    if (hint === "string") return `Amount(${this.value})`;
    return this.value;
  }
};

console.log(String(amount));
console.log(Number(amount));
console.log(amount + 3);

Výsledek

Amount(7)
7
10

Zobrazený kód a uvedený výsledek byly ověřeny v izolovaném prostředí metodou zaznamenanou v dokladu o ověření této přesné verze.

Zdroje