Le symboleSymbol.iterator définit l'itérateur par défaut d'un objet. C'est l'itérateur qui sera utilisé parfor...of.

Exemple interactif

const iterable1 = {};iterable1[Symbol.iterator] = function* () {  yield 1;  yield 2;  yield 3;};console.log([...iterable1]);// Expected output: Array [1, 2, 3]

Description

Lorsqu'on doit itérer sur un objet (par exemple avec une bouclefor..of), sa méthode@@iterator est appelée sans argument et l'itérateur renvoyé par la méthode est utilisé pour récupérer les valeurs sur lesquelles itérer.

Certains types natifs possèdent un comportement par défaut pour l'itération, d'autres types (tels qu'Object) n'ont pas de tel comportement. Les types natifs qui disposent d'une méthode@@iterator sont :

• Array.prototype[@@iterator]()
• TypedArray.prototype[@@iterator]()
• String.prototype[@@iterator]()
• Map.prototype[@@iterator]()
• Set.prototype[@@iterator]()

Pour plus d'informations, voir aussila page sur les protocoles d'itération.

Exemples

Itérables définis par l'utilisateur

Il est possible de construire un itérable de la façon suivante :

var monItérable = {};monItérable[Symbol.iterator] = function* () {  yield 1;  yield 2;  yield 3;};[...monItérable]; // [1, 2, 3]

On peut également définir ces itérables via des propriétés calculées dans des déclarations de classe ou dans des littéraux objets :

class Toto {  *[Symbol.iterator] () {    yield 1;    yield 2;    yield 3;  }}const monObj = {  *[Symbol.iterator] () {    yield "a";    yield "b";  }}[... new Toto] // [1, 2, 3][... monObj]   // ["a", "b"]

Itérables mal-formés

Si la méthode@@iterator d'un itérable ne renvoie pas un itérateur, on dira que c'est un itérable mal-formé. Utiliser un tel itérable peut provoquer des erreurs lors de l'exécution :

var itérableMalFormé = {}itérableMalFormé[Symbol.iterator] = () => 1[...itérableMalFormé] // TypeError: [] is not a function

Spécifications

Compatibilité des navigateurs

Voir aussi

• Les protocoles d'itération
• Array.prototype[@@iterator]()
• TypedArray.prototype[@@iterator]()
• String.prototype[@@iterator]()
• Map.prototype[@@iterator]()
• Set.prototype[@@iterator]()