Array.prototype.flat()
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since January 2020.
flat()
は Array
インスタンスのメソッドで、すべてのサブ配列の要素を指定した深さで再帰的に結合した新しい配列を生成します。
試してみましょう
構文
js
flat()
flat(depth)
引数
depth
省略可-
ネストされた配列構造で、どの程度の深さをフラット化するか指定する深さレベルです。 既定値は 1 です。
返値
サブ配列の要素を結合した新しい配列。
解説
例
ネストされた配列の平坦化
js
const arr1 = [1, 2, [3, 4]];
arr1.flat();
// [1, 2, 3, 4]
const arr2 = [1, 2, [3, 4, [5, 6]]];
arr2.flat();
// [1, 2, 3, 4, [5, 6]]
const arr3 = [1, 2, [3, 4, [5, 6]]];
arr3.flat(2);
// [1, 2, 3, 4, 5, 6]
const arr4 = [1, 2, [3, 4, [5, 6, [7, 8, [9, 10]]]]];
arr4.flat(Infinity);
// [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
平坦化と配列の穴
flat()
メソッドは配列内の空要素を削除します。
js
const arr5 = [1, 2, , 4, 5];
console.log(arr5.flat()); // [1, 2, 4, 5]
const array = [1, , 3, ["a", , "c"]];
console.log(array.flat()); // [ 1, 3, "a", "c" ]
const array2 = [1, , 3, ["a", , ["d", , "e"]]];
console.log(array2.flat()); // [ 1, 3, "a", ["d", empty, "e"] ]
console.log(array2.flat(2)); // [ 1, 3, "a", "d", "e"]
配列でないオブジェクトに対する flat() の呼び出し
flat()
メソッドは this
の length
プロパティを読み込み、キーが length
より小さい非負の整数である各プロパティにアクセスします。要素が配列でない場合は、結果に直接追加されます。要素が配列の場合は、引数 depth
に従って平坦化されます。
js
const arrayLike = {
length: 3,
0: [1, 2],
// 配列風オブジェクトは平坦化されない
1: { length: 2, 0: 3, 1: 4 },
2: 5,
3: 3, // length が 3 なので flat() から無視される
};
console.log(Array.prototype.flat.call(arrayLike));
// [ 1, 2, { '0': 3, '1': 4, length: 2 }, 5 ]
仕様書
Specification |
---|
ECMAScript Language Specification # sec-array.prototype.flat |
ブラウザーの互換性
BCD tables only load in the browser