【JavaScript ECMAScript】Array::Array.prototype.flatインスタンスメソッドの使い方
Array.prototype.flat()インスタンスメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
Array.prototype.flat()メソッドは、指定された深さまでネストされた（入れ子になった）配列のサブ配列要素を再帰的に平坦化し、新しい配列を生成するメソッドです。このメソッドは、配列の中にさらに配列が含まれるような複雑な構造を、より単純な一次元の配列に変換したい場合に利用されます。
引数としてオプションのdepth（深さ）を受け取ります。depthは、平坦化するレベルを示す整数値で、デフォルト値は1です。depthを1に設定した場合、配列の最も外側のネストされたサブ配列のみが平坦化されます。もし、任意の深さまで完全に平坦化したい場合は、Infinityという特別な値をdepthに指定することができます。
flat()メソッドは、呼び出し元の配列自体を変更することはありません。常に、平坦化された要素を持つ新しい配列を返します。これにより、元のデータ構造を安全に保ちながら、平坦化されたデータを操作することが可能になります。例えば、[[1, 2], [3, [4, 5]]].flat(2)と記述すると、[1, 2, 3, 4, 5]という新しい配列が返されます。この機能は、データ収集や処理の際に、複雑な配列データを整形し、扱いやすくするために役立ちます。
公式リファレンス: Array.prototype.flat()
構文(syntax)
1const array = [1, [2, 3], [[4, 5]]]; 2const flattenedArray = array.flat();
引数(parameters)
depth = 1
- depth: number = 1: 配列を何段階まで平坦化するかを指定する数値。デフォルトは1。
戻り値(return)
Array
指定された配列を、指定された深さまでネスト解除した新しい配列を返します。