Array.prototype.flatMap()

flatMap() メソッドは、最初にマッピング関数を使用してそれぞれの要素をマップした後、結果を新しい配列内にフラット化します。これは深さ 1 の flatten が続く map と同じですが、flatMap はしばしば有用であり、2 つのメソッドを 1 つにマージするよりもやや効果的です。

{{EmbedInteractiveExample("pages/js/array-flatmap.html")}}

The source for this interactive example is stored in a GitHub repository. If you'd like to contribute to the interactive examples project, please clone https://github.com/mdn/interactive-examples and send us a pull request.

構文

var new_array = arr.flatMap(function callback(currentValue[, index[, array]]) {
    // return element for new_array
}[, thisArg])

パラメーター

callback

新しい配列の要素を生成する関数。3 つの引数を受け取る:

currentValue

配列で現在処理されている要素。

indexOptional

配列で現在処理されている要素のインデックス。

arrayOptional

map が呼び出された配列。

thisArgOptional

callback を実行するときの this として用いられる値。

戻り値

各要素がコールバック関数の結果であり、深さが 1 にフラット化された新しい配列。

説明

コールバック関数の詳細については、Array.prototype.map() を見てください。flatMap メソッドは、深さ 1 の flatten が続く map と同じです。

例

map と flatMap

var arr1 = [1, 2, 3, 4];

arr1.map(x => [x * 2]); 
// [[2], [4], [6], [8]]

arr1.flatMap(x => [x * 2]);
// [2, 4, 6, 8]

// only one level is flattened
arr1.flatMap(x => [[x * 2]]);
// [[2], [4], [6], [8]]

代替え

reduce と concat

var arr1 = [1, 2, 3, 4];

arr1.flatMap(x => [x * 2]);
// is equivalent to
arr1.reduce((acc, x) => acc.concat([x * 2]), []);
// [2, 4, 6, 8]

仕様

ブラウザー実装状況

関連項目

• Array.prototype.flatten()
• Array.prototype.map()
• Array.prototype.reduce()
• Array.prototype.concat()