【JavaScript ECMAScript】Symbol::Symbol.prototype.toStringインスタンスメソッドの使い方

Symbol.prototype.toString()メソッドは、Symbolプリミティブ値の文字列表現を返すメソッドです。Symbolは、JavaScriptにおいて一意で変更不能な値を生成するために使用される特別なデータ型です。通常、Symbol値は、文字列や数値のように自動的に意味のある文字列に変換されません。そのため、Symbol値の内容をデバッグ時やログ出力時などに確認したい場合に、このtoString()メソッドが非常に役立ちます。

このメソッドをSymbol値に対して呼び出すと、Symbolを作成する際に任意で指定した説明（description）がある場合は、その説明を括弧で囲んだ「Symbol(description)」という形式の文字列を返します。例えば、Symbol('ユーザーID')というSymbolに対してtoString()を呼び出すと、"Symbol(ユーザーID)"という文字列が得られます。もし説明が指定されていないSymbolであれば、"Symbol()"という文字列を返します。

Symbol値は、オブジェクトのプロパティキーとして利用されることが多く、既存のプロパティ名との衝突を避けるために役立ちます。toString()メソッドは、これらのユニークなSymbol値を、人間が理解しやすい形で表現するための明確な手段を提供し、コードの可読性やデバッグの効率を向上させます。ただし、Symbol値と文字列を直接連結するような暗黙的な型変換では通常TypeErrorが発生するため、Symbol値を文字列として扱いたい場合は、このメソッドを明示的に使用することが重要です。

Copy
1const mySymbol = Symbol('description');
2mySymbol.toString();

引数なし

引数はありません

string

Symbol.prototype.toString()メソッドは、シンボル値の文字列表現を返します。この文字列表現は、シンボルが Symbol() コンストラクタによって生成された場合、「Symbol(description)」の形式になります。description はシンボルの説明（オプション）です。