【JavaScript ECMAScript】Symbol::Symbol.isConcatSpreadable静的データプロパティの使い方

Symbol.isConcatSpreadableプロパティは、Array.prototype.concat()メソッドが配列や他のオブジェクトを連結する際の挙動を制御するために使用されるプロパティです。このプロパティは、あるオブジェクトがconcat()メソッドの引数として渡されたときに、そのオブジェクトの中身をバラバラにして結合する（展開する）べきか、あるいはオブジェクト全体を一つの要素としてそのまま結合するべきかを決定します。

通常、concat()メソッドに配列を渡すと、その配列の要素は展開されて結果の配列に結合されます。しかし、Symbol.isConcatSpreadableプロパティをオブジェクトに設定することで、このデフォルトの挙動を変更できます。

もしオブジェクトにSymbol.isConcatSpreadableプロパティが存在し、その値がtrueであるか、あるいはプロパティ自体が未定義（存在しない）である場合、concat()メソッドはそのオブジェクトを配列のように扱い、その中身の要素をバラバラにして結合します。一方、このプロパティがfalseに設定されている場合、concat()メソッドはそのオブジェクトを単一の要素としてみなし、中身を展開せずにオブジェクト全体をそのまま結果の配列に追加します。

この機能は、特定のカスタムオブジェクトを定義する際に役立ちます。例えば、見た目は配列のようであっても、concat()で結合する際にはそのオブジェクト自体を一つの塊として扱ってほしい場合に、Symbol.isConcatSpreadableをfalseに設定することで、意図した動作を実現できます。これにより、JavaScript開発者は配列の連結操作をより細かく制御し、多様なデータ構造を柔軟に扱えるようになります。

Copy
1const customObject = {
2  0: 'a',
3  1: 'b',
4  length: 2,
5  [Symbol.isConcatSpreadable]: true
6};

引数なし

引数はありません

symbol

Symbol.isConcatSpreadable は、配列の concat メソッドなどで、そのオブジェクトが配列のように展開されるべきかどうかを示すために内部的に使用されるシンボルを返します。