The [@@toPrimitive]()
method converts a Symbol object to a primitive value.
Symbol.prototype[@@toPrimitive]
Syntax
Symbol()[Symbol.toPrimitive](hint)
Return value
The primitive value of the specified Symbol
object.
Description
The [@@toPrimitive]()
method of Symbol
returns the primitive value of a Symbol object as a Symbol data type. The hint
argument is not used.
JavaScript calls the [@@toPrimitive]()
method to convert an object to a primitive value. You rarely need to invoke the [@@toPrimitive]()
method yourself; JavaScript automatically invokes it when encountering an object where a primitive value is expected.
Examples
Using @@toPrimitive
const sym = Symbol("example"); sym === sym[Symbol.toPrimitive](); // true
Specifications
Browser compatibility
Desktop | Mobile | Server | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | Deno | Node.js | |
@@toPrimitive |
47
|
15
|
44
|
No
|
34
|
10
|
47
|
47
|
44
|
34
|
10
|
5.0
|
1.0
|
6.0.0
|
See also
© 2005–2022 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/@@toPrimitive