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

CKTIS / JavaScript

Symbol.iterator — le protocole d’itération synchrone

Symbol.iterator est le symbole bien connu qui désigne une méthode produisant un itérateur. Il permet à un objet personnalisé de fonctionner avec for...of et la syntaxe de décomposition en tableau. Un itérable fournit un itérateur, qui fournit des résultats successifs grâce à 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

iterable[Symbol.iterator]()
({ [Symbol.iterator]() { return iterator; } })

Symbol.iterator est un symbole bien connu, et non une fonction. Il sert de clé à la méthode [Symbol.iterator]() d’un objet itérable (iterable). Cette méthode renvoie un itérateur utilisé notamment par for...of et la syntaxe de décomposition en tableau ([...iterable]). La clé de chaîne "Symbol.iterator" n’est pas la même clé.

Un itérable fournit cette méthode, tandis qu’un itérateur possède une méthode next(). Chaque appel à next() doit renvoyer un objet résultat : done indique si l’itération est terminée, et value contient l’élément courant tant que l’itération continue. Lorsque done: true, des consommateurs comme for...of ne traitent pas value comme un élément. La seule présence de next() ne rend pas un objet itérable.

Dans l’exemple, chaque appel à [Symbol.iterator]() crée un compteur distinct. Les deux décompositions produisent donc 1,2,3. Un itérateur n’a pas besoin d’être lui-même itérable ; pour le rendre itérable, il peut fournir [Symbol.iterator]() en renvoyant this. Renvoyer le même itérateur ne garantit pas que l’itération recommence.

Un objet ordinaire ne devient pas itérable simplement parce qu’il possède des propriétés. Une implémentation incorrecte, qui renvoie par exemple un nombre au lieu d’un objet depuis next(), provoque une TypeError lors de l’utilisation du protocole. Ce mécanisme est synchrone ; le protocole asynchrone utilise le symbole distinct Symbol.asyncIterator.

Exemples

const numbers = {
  [Symbol.iterator]() {
    let current = 1;
    return {
      next() {
        if (current <= 3) {
          return { value: current++, done: false };
        }
        return { done: true };
      }
    };
  }
};

console.log([...numbers].join(','));
console.log([...numbers].join(','));

Résultat

1,2,3
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