Symbol.prototype[Symbol.toPrimitive]()

[Symbol.toPrimitive]() メソッドは、Symbol オブジェクトをプリミティブ値に変換します。

構文

js
symbolValue[Symbol.toPrimitive](hint)

引数

hint

文字列値で、返すプリミティブ値を示します。この値は無視されます。

返値

Symbol オブジェクトで指定されたプリミティブ値です。

解説

[Symbol.toPrimitive]() は Symbol オブジェクトのメソッドで、Symbol オブジェクトのプリミティブ値を Symbol データ型として返します。 hint 引数は使われません。

JavaScript はオブジェクトをプリミティブ値に変換するために [Symbol.toPrimitive]() メソッドを呼び出します。 [Symbol.toPrimitive]() メソッドを自分で呼び出す必要はほとんどありません。 JavaScript は、プリミティブ値が期待されているオブジェクトに遭遇したときに、自動的にこれを呼び出します。

例

[Symbol.toPrimitive]() の使用

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

仕様書

Specification
ECMAScript Language Specification
# sec-symbol.prototype-%symbol.toprimitive%

ブラウザーの互換性

BCD tables only load in the browser

関連情報