Symbol.toPrimitive

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2015.

O Symbol.toPrimitive é um símbolo que específica uma propriedade com valor função que é chamada para converter um ojbeto para um valor primitivo correspondente.

Experimente

const object1 = {
  [Symbol.toPrimitive](hint) {
    if (hint === "number") {
      return 42;
    }
    return null;
  },
};

console.log(+object1);
// Expected output: 42

Descrição

Com a ajuda da propriedade Symbol.toPrimitive (usada como uma função valor), um objeto pode ser convertido para um valor primitivo. a função é chamada com um argumento string hint, que espcífica o tipo de preferência do resultado do valor primitivo. O argumento hint pode ser um "number", "string", e "default".

Property attributes of Symbol.toPrimitive
Writableno
Enumerableno
Configurableno

Exemplos

Modificando valores primitivos convertendo para um objeto

O exemplo a seguir descreve que a propriedade Symbol.toPrimitive pode ser modificar o valor primitivo convertendo para um objeto.

js
// Um objeto sem propriedade Symbol.toPrimitive.
var obj1 = {};
console.log(+obj1); // NaN
console.log(`${obj1}`); // "[object Object]"
console.log(obj1 + ""); // "[object Object]"

// Um objeto com propriedade Symbol.toPrimitive
var obj2 = {
  [Symbol.toPrimitive](hint) {
    if (hint == "number") {
      return 10;
    }
    if (hint == "string") {
      return "hello";
    }
    return true;
  },
};
console.log(+obj2); // 10        -- dica é "number"
console.log(`${obj2}`); // "hello"   -- dica é "string"
console.log(obj2 + ""); // "true"    -- dica é "default"

Especificações

Specification
ECMAScript® 2025 Language Specification
# sec-symbol.toprimitive

Compatibilidade com navegadores

Report problems with this compatibility data on GitHub
desktopmobileserver
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
Deno
Node.js
toPrimitive

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support

Veja também