【Node.js24.x】Symbol::toStringTag定数の使い方

toStringTag定数は、JavaScriptの組み込みオブジェクトであるSymbolのプロパティとして提供され、オブジェクトのデフォルトの文字列表現をカスタマイズするための内部的なタグを表す定数です。この定数は、JavaScriptの標準メソッドであるObject.prototype.toString()が呼び出された際に、そのオブジェクトの型を示す文字列を決定するために利用されます。

通常、Object.prototype.toString()は、呼び出し元のオブジェクトの種類に応じて、例えば[object Array]や[object Function]といった形式の文字列を返します。しかし、開発者が作成したカスタムオブジェクトに対し、Symbol.toStringTagをキーとするプロパティを定義し、任意の文字列を値として設定することで、このデフォルトの挙動を変更できます。

たとえば、あるオブジェクトに[Symbol.toStringTag]: "MyCustomObject"というプロパティを設定した場合、そのオブジェクトに対してObject.prototype.toString()を実行すると、[object MyCustomObject]という文字列が返されるようになります。

この機能は、独自のクラスやオブジェクトを定義した際に、そのインスタンスがどのような種類のオブジェクトであるかをObject.prototype.toString()を使って明確に識別できるようにします。これにより、デバッグ作業や動的な型チェックが必要な場面において、オブジェクトの挙動をより直感的に理解し、コードの可読性を高める上で非常に役立つ機能です。

Copy
1const myObject = {
2  [Symbol.toStringTag]: 'MyCustomObject'
3};
4
5console.log(Object.prototype.toString.call(myObject));

引数なし

引数はありません

symbol

Symbol.toStringTagは、オブジェクトのObject.prototype.toString()メソッドによって返される文字列タグを指定するためのシンボルです。このシンボルは、オブジェクトの型を識別するためのカスタムタグを設定するために使用されます。