for await...of

for await (variable of iterable)
  statement

variable

Empfängt einen Wert aus der Sequenz bei jeder Iteration. Kann entweder eine Deklaration mit const, let oder var sein oder ein Zuweisungsziel (z. B. eine zuvor deklarierte Variable, eine Objekteigenschaft oder ein Destrukturierungsmuster). Mit var deklarierte Variablen sind nicht lokal zur Schleife, d.h. sie sind im gleichen Gültigkeitsbereich wie die for await...of-Schleife.

iterable

Ein asynchrones oder synchrones Iterable. Die Quelle der Wertesequenz, auf der die Schleife operiert.

statement

Eine Anweisung, die bei jeder Iteration ausgeführt wird. Kann variable referenzieren. Sie können eine Block-Anweisung verwenden, um mehrere Anweisungen auszuführen.

Wenn eine for await...of-Schleife über ein Iterable iteriert, holt sie zuerst die [Symbol.asyncIterator]()-Methode des Iterables und ruft sie auf, wodurch ein asynchroner Iterator zurückgegeben wird. Wenn die @asyncIterator-Methode nicht existiert, wird nach einer [Symbol.iterator]()-Methode gesucht, die einen synchronen Iterator zurückgibt. Der erzeugte synchrone Iterator wird dann in einen asynchronen Iterator umgewandelt, indem jedes Objekt, das von den next(), return() und throw()-Methoden zurückgegeben wird, in ein versprochenes oder abgelehntes Versprechen eingewickelt wird, wobei die value-Eigenschaft aufgelöst wird, wenn sie ebenfalls ein Versprechen ist. Die Schleife ruft dann wiederholt die next()-Methode des endgültigen asynchronen Iterators auf und wartet das zurückgegebene Versprechen ab, um die Sequenz von Werten zu erzeugen, die variable zugewiesen werden.

Eine for await...of-Schleife endet, wenn der Iterator abgeschlossen ist (das abgewartete next()-Resultat ist ein Objekt mit done: true). Wie bei anderen Schleifenanweisungen können Sie Kontrollflussanweisungen innerhalb von statement verwenden:

• break stoppt die Ausführung von statement und geht zur ersten Anweisung nach der Schleife.
• continue stoppt die Ausführung von statement und wechselt zur nächsten Iteration der Schleife.

Wenn die for await...of-Schleife vorzeitig beendet wurde (z. B. wenn eine break-Anweisung auftritt oder ein Fehler auftritt), wird die return()-Methode des Iterators aufgerufen, um Bereinigungen durchzuführen. Das zurückgegebene Versprechen wird abgewartet, bevor die Schleife endet.

for await...of funktioniert im Allgemeinen genauso wie die for...of-Schleife und teilt viele der gleichen Syntax und Semantik. Es gibt einige Unterschiede:

• for await...of funktioniert sowohl mit synchronen als auch mit asynchronen Iterables, während for...of nur mit synchronen Iterables funktioniert.
• for await...of kann nur in Kontexten verwendet werden, in denen await verwendet werden kann, was das Innere einer asynchronen Funktion und eines Moduls einschließt. Selbst wenn das Iterable synchron ist, wartet die Schleife dennoch den Rückgabewert für jede Iteration ab, was aufgrund des wiederholten Auspackens von Versprechen zu einer langsameren Ausführung führt.
• Wenn das iterable ein synchrones Iterable ist, das Versprechen liefert, würde for await...of eine Sequenz gelöster Werte produzieren, während for...of eine Sequenz von Versprechen produzieren würde. (Beachten Sie jedoch die Fehlerbehandlung und Bereinigung — siehe Iterating over sync iterables and generators)
• Für for await...of kann variable der Bezeichner async sein (z. B. for await (async of foo)); for...of verbietet diesen Fall.

Sie können auch über ein Objekt iterieren, das explizit das asynchrone Iterationsprotokoll implementiert:

const LIMIT = 3;

const asyncIterable = {
  [Symbol.asyncIterator]() {
    let i = 0;
    return {
      next() {
        const done = i === LIMIT;
        const value = done ? undefined : i++;
        return Promise.resolve({ value, done });
      },
      return() {
        // This will be reached if the consumer called 'break' or 'return' early in the loop.
        return { done: true };
      },
    };
  },
};

(async () => {
  for await (const num of asyncIterable) {
    console.log(num);
  }
})();
// 0
// 1
// 2

Da die Rückgabewerte von asynchronen Generatorfunktionen dem asynchronen Iterationsprotokoll entsprechen, können sie mit for await...of durchlaufen werden.

async function* asyncGenerator() {
  let i = 0;
  while (i < 3) {
    yield i++;
  }
}

(async () => {
  for await (const num of asyncGenerator()) {
    console.log(num);
  }
})();
// 0
// 1
// 2

Für ein konkreteres Beispiel für das Iterieren über einen asynchronen Generator mit for await...of, ziehen Sie das Iterieren über Daten von einer API in Betracht.

Dieses Beispiel erstellt zunächst ein asynchrones Iterable für einen Datenstrom und verwendet es dann, um die Größe der Antwort von der API zu ermitteln.

async function* streamAsyncIterable(stream) {
  const reader = stream.getReader();
  try {
    while (true) {
      const { done, value } = await reader.read();
      if (done) return;
      yield value;
    }
  } finally {
    reader.releaseLock();
  }
}

// Fetches data from URL and calculates response size using the async generator.
async function getResponseSize(url) {
  const response = await fetch(url);
  // Will hold the size of the response, in bytes.
  let responseSize = 0;
  // The for-await-of loop. Async iterates over each portion of the response.
  for await (const chunk of streamAsyncIterable(response.body)) {
    // Incrementing the total response length.
    responseSize += chunk.length;
  }

  console.log(`Response Size: ${responseSize} bytes`); // "Response Size: 1071472"
  return responseSize;
}
getResponseSize("https://jsonplaceholder.typicode.com/photos");

Die for await...of-Schleife konsumiert auch synchrone Iterables und Generatoren. In diesem Fall wartet sie intern auf ausgegebene Werte, bevor sie sie der Schleifenkontrollvariablen zuweist.

function* generator() {
  yield 0;
  yield 1;
  yield Promise.resolve(2);
  yield Promise.resolve(3);
  yield 4;
}

(async () => {
  for await (const num of generator()) {
    console.log(num);
  }
})();
// 0
// 1
// 2
// 3
// 4

// compare with for-of loop:

for (const numOrPromise of generator()) {
  console.log(numOrPromise);
}
// 0
// 1
// Promise { 2 }
// Promise { 3 }
// 4

function* generatorWithRejectedPromises() {
  try {
    yield 0;
    yield 1;
    yield Promise.resolve(2);
    yield Promise.reject(3);
    yield 4;
    throw 5;
  } finally {
    console.log("called finally");
  }
}

(async () => {
  try {
    for await (const num of generatorWithRejectedPromises()) {
      console.log(num);
    }
  } catch (e) {
    console.log("caught", e);
  }
})();
// 0
// 1
// 2
// caught 3

// compare with for-of loop:

try {
  for (const numOrPromise of generatorWithRejectedPromises()) {
    console.log(numOrPromise);
  }
} catch (e) {
  console.log("caught", e);
}
// 0
// 1
// Promise { 2 }
// Promise { <rejected> 3 }
// 4
// caught 5
// called finally

Um sicherzustellen, dass die finally-Blöcke eines synchronen Generators immer aufgerufen werden, verwenden Sie die passende Form der Schleife — for await...of für den asynchronen Generator und for...of für den synchronen — und warten Sie explizit auf gelieferte Versprechen innerhalb der Schleife.

(async () => {
  try {
    for (const numOrPromise of generatorWithRejectedPromises()) {
      console.log(await numOrPromise);
    }
  } catch (e) {
    console.log("caught", e);
  }
})();
// 0
// 1
// 2
// caught 3
// called finally

• Symbol.asyncIterator
• for...of