W3cubDocs

/JavaScript

Symbol.prototype[@@toPrimitive]()

The [@@toPrimitive]() method of Symbol values returns this symbol value.

Syntax

js
symbolValue[Symbol.toPrimitive](hint)

Parameters

hint

A string value indicating the primitive value to return. The value is ignored.

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

js
const sym = Symbol("example");
sym === sym[Symbol.toPrimitive](); // true

Specifications

Browser compatibility

Desktop Mobile Server
Chrome Edge Firefox Opera Safari Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet WebView Android Deno Node.js
@@toPrimitive 47 15 44 34 10 47 44 34 10 5.0 47 1.0 6.0.0

See also

© 2005–2023 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