Array.prototype.flatMap()

callbackFn

Eine Funktion, die für jedes Element im Array ausgeführt wird. Sie sollte ein Array zurückgeben, das neue Elemente des neuen Arrays enthält, oder einen einzelnen Nicht-Array-Wert, der dem neuen Array hinzugefügt wird. Die Funktion wird mit den folgenden Argumenten aufgerufen:

element

Das aktuelle Element, das im Array verarbeitet wird.

index

Der Index des aktuellen Elements, das im Array verarbeitet wird.

array

Das Array, auf dem flatMap() aufgerufen wurde.

thisArg Optional

Ein Wert, der als this beim Ausführen von callbackFn verwendet wird. Siehe iterative Methoden.

Ein neues Array, bei dem jedes Element das Ergebnis der Callback-Funktion ist und mit einer Tiefe von 1 abgeflacht ist.

Die flatMap() Methode ist eine iterative Methode. Siehe Array.prototype.map() für eine detaillierte Beschreibung der Callback-Funktion. Die flatMap() Methode ist identisch zu map(callbackFn, thisArg) gefolgt von flat(1) — für jedes Element erzeugt sie ein Array neuer Elemente und fügt die resultierenden Arrays zusammen, um ein neues Array zu bilden. Lesen Sie den Abschnitt über iterative Methoden, um mehr über die Funktionsweise dieser Methoden im Allgemeinen zu erfahren.

Die flatMap() Methode ist generisch. Sie erwartet lediglich, dass der this Wert eine length Eigenschaft und integer-basierte Eigenschaften hat. Jedoch muss der von callbackFn zurückgegebene Wert ein Array sein, wenn er abgeflacht werden soll.

Vorab reservieren und explizit iterieren

const arr = [1, 2, 3, 4];

arr.flatMap((x) => [x, x * 2]);
// is equivalent to
const n = arr.length;
const acc = new Array(n * 2);
for (let i = 0; i < n; i++) {
  const x = arr[i];
  acc[i * 2] = x;
  acc[i * 2 + 1] = x * 2;
}
// [1, 2, 2, 4, 3, 6, 4, 8]

Beachten Sie, dass in diesem speziellen Fall der flatMap-Ansatz langsamer ist als der for-Schleifen-Ansatz — aufgrund der Erstellung temporärer Arrays, die dem Garbage Collector überlassen werden müssen, sowie des Rückgabe-Arrays, das nicht häufig größer werden muss. Dennoch kann flatMap die richtige Lösung in Fällen sein, in denen Flexibilität und Lesbarkeit gewünscht sind.

const 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]]

Obwohl das Obige durch die Verwendung von map selbst erreicht werden könnte, hier ein Beispiel, das die Nutzung von flatMap() besser veranschaulicht.

Lassen Sie uns eine Liste von Wörtern aus einer Liste von Sätzen generieren.

const arr1 = ["it's Sunny in", "", "California"];

arr1.map((x) => x.split(" "));
// [["it's","Sunny","in"],[""],["California"]]

arr1.flatMap((x) => x.split(" "));
// ["it's","Sunny","in", "", "California"]

Beachten Sie, dass die Länge der Ausgabeliste von der Länge der Eingabeliste abweichen kann.

flatMap kann verwendet werden, um Elemente hinzuzufügen und zu entfernen (die Anzahl der Elemente zu ändern) während eines map. Mit anderen Worten, es ermöglicht Ihnen, viele Elemente zu vielen Elementen zu mappen (indem Sie jedes Eingabeelement separat behandeln), anstatt immer eins-zu-eins. In diesem Sinne funktioniert es wie das Gegenteil von filter. Geben Sie ein 1-Element-Array zurück, um das Element zu behalten, ein Mehrfach-Element-Array, um Elemente hinzuzufügen, oder ein 0-Element-Array, um das Element zu entfernen.

// Let's say we want to remove all the negative numbers
// and split the odd numbers into an even number and a 1
const a = [5, 4, -3, 20, 17, -33, -4, 18];
//         |\  \  x   |  | \   x   x   |
//        [4,1, 4,   20, 16, 1,       18]

const result = a.flatMap((n) => {
  if (n < 0) {
    return [];
  }
  return n % 2 === 0 ? [n] : [n - 1, 1];
});
console.log(result); // [4, 1, 4, 20, 16, 1, 18]

Das array-Argument ist nützlich, wenn Sie auf ein anderes Element im Array zugreifen möchten, besonders wenn Sie keine vorhandene Variable haben, die auf das Array verweist. Das folgende Beispiel verwendet zuerst filter(), um betriebsbereite Stationen zu extrahieren und verwendet dann flatMap(), um ein neues Array zu erstellen, wobei jedes Element eine Station und ihre nächste Station enthält. Bei der letzten Station wird ein leeres Array zurückgegeben, um sie vom endgültigen Array auszuschließen.

const stations = ["New Haven", "West Haven", "Milford (closed)", "Stratford"];
const line = stations
  .filter((name) => !name.endsWith("(closed)"))
  .flatMap((name, idx, arr) => {
    // Without the arr argument, there's no way to easily access the
    // intermediate array without saving it to a variable.
    if (idx === arr.length - 1) return []; // last station has no next station
    return [`${name} - ${arr[idx + 1]}`];
  });
console.log(line); // ['New Haven - West Haven', 'West Haven - Stratford']

Das array Argument ist nicht das Array, das gerade erstellt wird — es gibt keine Möglichkeit, auf das erstellende Array aus der Callback-Funktion zuzugreifen.

Die callbackFn wird nicht für leere Stellen im Quellarray aufgerufen, weil map() das nicht tut, während flat() leere Stellen in den zurückgegebenen Arrays ignoriert.

console.log([1, 2, , 4, 5].flatMap((x) => [x, x * 2])); // [1, 2, 2, 4, 4, 8, 5, 10]
console.log([1, 2, 3, 4].flatMap((x) => [, x * 2])); // [2, 4, 6, 8]

Die flatMap()-Methode liest die length-Eigenschaft von this und greift dann auf jede Eigenschaft zu, deren Schlüssel eine nicht-negative Ganzzahl ist, die kleiner als length ist. Wenn der Rückgabewert der Callback-Funktion kein Array ist, wird er immer direkt dem Ergebnisarray hinzugefügt.

const arrayLike = {
  length: 3,
  0: 1,
  1: 2,
  2: 3,
  3: 4, // ignored by flatMap() since length is 3
};
console.log(Array.prototype.flatMap.call(arrayLike, (x) => [x, x * 2]));
// [1, 2, 2, 4, 3, 6]

// Array-like objects returned from the callback won't be flattened
console.log(
  Array.prototype.flatMap.call(arrayLike, (x) => ({
    length: 1,
    0: x,
  })),
);
// [ { '0': 1, length: 1 }, { '0': 2, length: 1 }, { '0': 3, length: 1 } ]

• Polyfill von Array.prototype.flatMap in core-js
• Indexed collections Leitfaden
• Array
• Array.prototype.concat()
• Array.prototype.flat()
• Array.prototype.map()
• Array.prototype.reduce()