Array.prototype.forEach()

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

Die Methode forEach() von Array-Instanzen führt eine bereitgestellte Funktion einmal für jedes Array-Element aus.

Probieren Sie es aus

Syntax

js
forEach(callbackFn)
forEach(callbackFn, thisArg)

Parameter

callbackFn

Eine Funktion, die für jedes Element im Array ausgeführt wird. Ihr Rückgabewert wird verworfen. 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 das forEach() angewendet wurde.

thisArg Optional

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

Rückgabewert

Keiner (undefined).

Beschreibung

Die forEach() Methode ist eine iterative Methode. Sie ruft eine bereitgestellte callbackFn Funktion einmal für jedes Element in einem Array in aufsteigender Indexreihenfolge auf. Im Gegensatz zu map() gibt forEach() immer undefined zurück und ist nicht kettefähig. Der typische Anwendungsfall besteht darin, Seiteneffekte am Ende einer Kette auszuführen. Lesen Sie den Abschnitt iterative Methoden, um mehr darüber zu erfahren, wie diese Methoden allgemein funktionieren.

callbackFn wird nur für Array-Indizes aufgerufen, denen Werte zugewiesen sind. Sie wird nicht für leere Stellen in sparse Arrays aufgerufen.

Die forEach() Methode ist generisch. Sie erwartet nur, dass der this Wert eine length Eigenschaft und integerbasierte Schlüsseleigenschaften hat.

Es gibt keine Möglichkeit, eine forEach() Schleife anzuhalten oder zu unterbrechen, außer durch das Werfen einer Ausnahme. Wenn Sie ein solches Verhalten benötigen, ist die forEach() Methode nicht das richtige Werkzeug.

Ein vorzeitiges Beenden kann mit Schleifenanweisungen wie for, for...of und for...in erreicht werden. Array-Methoden wie every(), some(), find() und findIndex() stoppen ebenfalls die Iteration sofort, wenn eine weitere Iteration nicht erforderlich ist.

forEach() erwartet eine synchron ausgeführte Funktion — es wartet nicht auf promises. Stellen Sie sicher, dass Sie die Auswirkungen kennen, wenn Sie promises (oder async Funktionen) als forEach Rückrufe verwenden.

js
const ratings = [5, 4, 5];
let sum = 0;

const sumFunction = async (a, b) => a + b;

ratings.forEach(async (rating) => {
  sum = await sumFunction(sum, rating);
});

console.log(sum);
// Naively expected output: 14
// Actual output: 0

Um eine Reihe von asynchronen Operationen nacheinander oder gleichzeitig auszuführen, siehe Promise-Komposition.

Beispiele

Umwandlung einer for-Schleife in forEach

js
const items = ["item1", "item2", "item3"];
const copyItems = [];

// before
for (let i = 0; i < items.length; i++) {
  copyItems.push(items[i]);
}

// after
items.forEach((item) => {
  copyItems.push(item);
});

Inhalt eines Arrays ausgeben

Hinweis: Um den Inhalt eines Arrays in der Konsole anzuzeigen, können Sie console.table() verwenden, das eine formatierte Version des Arrays ausdruckt.

Das folgende Beispiel veranschaulicht einen alternativen Ansatz unter Verwendung von forEach().

Der folgende Code protokolliert eine Zeile für jedes Element in einem Array:

js
const logArrayElements = (element, index /*, array */) => {
  console.log(`a[${index}] = ${element}`);
};

// Notice that index 2 is skipped, since there is no item at
// that position in the array.
[2, 5, , 9].forEach(logArrayElements);
// Logs:
// a[0] = 2
// a[1] = 5
// a[3] = 9

Verwendung von thisArg

Das folgende (künstliche) Beispiel aktualisiert die Eigenschaften eines Objekts aus jedem Eintrag im Array:

js
class Counter {
  constructor() {
    this.sum = 0;
    this.count = 0;
  }
  add(array) {
    // Only function expressions have their own this bindings.
    array.forEach(function countEntry(entry) {
      this.sum += entry;
      ++this.count;
    }, this);
  }
}

const obj = new Counter();
obj.add([2, 5, 9]);
console.log(obj.count); // 3
console.log(obj.sum); // 16

Da der thisArg Parameter (this) an forEach() übergeben wird, wird er jedes Mal an callback weitergereicht, wenn es aufgerufen wird. Der Rückruf verwendet ihn als seinen this Wert.

Hinweis: Wenn die Rückruffunktion mit einem Arrow Function Ausdruck verwendet wird, kann der thisArg Parameter weggelassen werden, da alle arrow Funktionen das this lexikalisch binden.

Eine Objektkopierfunktion

Der folgende Code erstellt eine Kopie eines gegebenen Objekts.

Es gibt verschiedene Möglichkeiten, eine Kopie eines Objekts zu erstellen. Dies ist nur eine Methode und wird hier präsentiert, um zu erklären, wie Array.prototype.forEach() funktioniert, indem Object.* Hilfsfunktionen verwendet werden.

js
const copy = (obj) => {
  const copy = Object.create(Object.getPrototypeOf(obj));
  const propNames = Object.getOwnPropertyNames(obj);
  propNames.forEach((name) => {
    const desc = Object.getOwnPropertyDescriptor(obj, name);
    Object.defineProperty(copy, name, desc);
  });
  return copy;
};

const obj1 = { a: 1, b: 2 };
const obj2 = copy(obj1); // obj2 looks like obj1 now

Ein Array abflachen

Das folgende Beispiel ist nur zu Lernzwecken. Wenn Sie ein Array mit eingebauten Methoden abflachen möchten, können Sie Array.prototype.flat() verwenden.

js
const flatten = (arr) => {
  const result = [];
  arr.forEach((item) => {
    if (Array.isArray(item)) {
      result.push(...flatten(item));
    } else {
      result.push(item);
    }
  });
  return result;
};

// Usage
const nested = [1, 2, 3, [4, 5, [6, 7], 8, 9]];
console.log(flatten(nested)); // [1, 2, 3, 4, 5, 6, 7, 8, 9]

Verwendung des dritten Arguments von callbackFn

Das array Argument ist nützlich, wenn Sie auf ein anderes Element im Array zugreifen möchten, insbesondere wenn Sie keine vorhandene Variable haben, die auf das Array verweist. Das folgende Beispiel verwendet zunächst filter(), um die positiven Werte zu extrahieren und dann forEach(), um seine Nachbarn zu protokollieren.

js
const numbers = [3, -1, 1, 4, 1, 5];
numbers
  .filter((num) => num > 0)
  .forEach((num, idx, arr) => {
    // Without the arr argument, there's no way to easily access the
    // intermediate array without saving it to a variable.
    console.log(arr[idx - 1], num, arr[idx + 1]);
  });
// undefined 3 1
// 3 1 4
// 1 4 1
// 4 1 5
// 1 5 undefined

Verwendung von forEach() bei sparsamen Arrays

js
const arraySparse = [1, 3, /* empty */, 7];
let numCallbackRuns = 0;

arraySparse.forEach((element) => {
  console.log({ element });
  numCallbackRuns++;
});

console.log({ numCallbackRuns });

// { element: 1 }
// { element: 3 }
// { element: 7 }
// { numCallbackRuns: 3 }

Die Rückruffunktion wird nicht für den fehlenden Wert an Index 2 aufgerufen.

Aufruf von forEach() auf Nicht-Array-Objekten

Die forEach() Methode liest die length Eigenschaft von this und greift dann auf jede Eigenschaft zu, deren Schlüssel eine nicht-negative ganze Zahl kleiner als length ist.

js
const arrayLike = {
  length: 3,
  0: 2,
  1: 3,
  2: 4,
  3: 5, // ignored by forEach() since length is 3
};
Array.prototype.forEach.call(arrayLike, (x) => console.log(x));
// 2
// 3
// 4

Spezifikationen

Specification
ECMAScript Language Specification
# sec-array.prototype.foreach

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch