The [@@toPrimitive]()
method converts a Symbol object to a primitive value.
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
Specification |
---|
ECMAScript (ECMA-262) The definition of 'Symbol.prototype.@@toPrimitive' in that specification. |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Desktop | Mobile | Server | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@@toPrimitive | Chrome Full support 47 | Edge Full support 15 | Firefox Full support 44 | IE No support No | Opera Full support 34 | Safari Full support 10 | WebView Android Full support 47 | Chrome Android Full support 47 | Firefox Android Full support 44 | Opera Android Full support 34 | Safari iOS Full support 10 | Samsung Internet Android Full support 5.0 | nodejs Full support 6.0.0 |
Legend
- Full support
- Full support
- No support
- No support