Symbol.prototype[@@toPrimitive]

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

Update compatibility data on GitHub
DesktopMobileServer
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung InternetNode.js
@@toPrimitiveChrome Full support 47Edge Full support 15Firefox Full support 44IE No support NoOpera Full support 34Safari Full support 10WebView Android Full support 47Chrome Android Full support 47Firefox Android Full support 44Opera Android Full support 34Safari iOS Full support 10Samsung Internet Android Full support 5.0nodejs Full support 6.0.0

Legend

Full support  
Full support
No support  
No support

See also