Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / JavaScript

Symbol.asyncIterator — le protocole d’itération asynchrone

Symbol.asyncIterator est un symbole intégré qui désigne la méthode fournissant l’itérateur asynchrone d’un objet. Il permet à for await...of de récupérer les valeurs successives en attendant les résultats de next().

Version : ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support

Syntaxe

Symbol.asyncIterator
object[Symbol.asyncIterator]()
async *[Symbol.asyncIterator]() { /* yield values */ }

Symbol.asyncIterator est un symbole bien connu utilisé comme clé de propriété, et non une fonction à appeler directement. La méthode object[Symbol.asyncIterator]() renvoie un itérateur asynchrone — l’objet itérateur lui-même, et non une promesse contenant un itérateur. Ce mécanisme fait partie d’ECMAScript depuis ECMAScript 2018 (ES2018) ; ce n’est pas une API Web.

Un objet itérable asynchrone fournit cette méthode, tandis qu’un itérateur asynchrone fournit next(), qui renvoie une promesse dont la valeur de résolution est un objet résultat. Si la propriété done est absente, le résultat est traité comme s’il contenait done: false. Un résultat avec done: true signale la fin de l’itération et peut ne pas contenir la propriété value. La syntaxe async *[Symbol.asyncIterator]() définit une méthode de générateur asynchrone qui gère automatiquement ce protocole.

La boucle for await...of recherche d’abord Symbol.asyncIterator. Si la méthode est absente ou vaut null, elle utilise Symbol.iterator et adapte l’itérateur synchrone. Une boucle ordinaire for...of n’utilise pas Symbol.asyncIterator. Ne déclarez pas la fabrique d’itérateur comme une simple méthode async : elle renverrait une promesse au lieu d’un itérateur.

Dans l’exemple, chaque appel de méthode crée un nouveau générateur, et la boucle recueille les valeurs dans l’ordre. Vérifiez la prise en charge de la syntaxe et du symbole dans l’environnement cible ; la seule présence de Symbol.asyncIterator comme l’utilisation de Node 24 dans le dépôt ne prouve pas la compatibilité avec les navigateurs.

Exemples

const numbers = {
  async *[Symbol.asyncIterator]() {
    yield 1;
    yield 2;
    yield 3;
  }
};

async function main() {
  const values = [];
  for await (const value of numbers) {
    values.push(value);
  }
  console.log(values.join(', '));
}

main().catch(console.error);

Résultat

1, 2, 3

Le code affiché et le résultat déclaré ont été vérifiés dans un environnement isolé selon la méthode consignée dans la preuve de vérification de cette version exacte.

Sources