Base di conoscenzaCentro esami
ITItaliano
Scegli la lingua13

CKTIS / JavaScript

Symbol.iterator — il protocollo di iterazione sincrona

Symbol.iterator è il simbolo noto che identifica un metodo capace di creare un iteratore. Permette a un oggetto personalizzato di funzionare con for...of e con la sintassi spread degli array. Un iterabile fornisce un iteratore, che restituisce risultati successivi tramite next().

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

Sintassi

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

Symbol.iterator è un simbolo noto, non una funzione. È la chiave del metodo [Symbol.iterator]() di un oggetto iterabile (iterable). Questo metodo restituisce un iteratore utilizzato, tra gli altri, da for...of e dalla sintassi spread degli array ([...iterable]). La chiave stringa "Symbol.iterator" non è la stessa chiave.

Un iterabile fornisce questo metodo, mentre un iteratore ha un metodo next(). Ogni chiamata a next() deve restituire un oggetto risultato: done indica se l’iterazione è terminata e value contiene l’elemento corrente finché l’iterazione prosegue. Quando done: true, consumatori come for...of non elaborano value come un elemento. La sola presenza di next() non rende un oggetto iterabile.

Nell’esempio, ogni chiamata a [Symbol.iterator]() crea un contatore separato. Perciò entrambe le operazioni spread producono 1,2,3. Un iteratore non deve necessariamente essere iterabile; per renderlo tale, può fornire [Symbol.iterator]() restituendo this. Restituire lo stesso iteratore non garantisce che l’iterazione ricominci.

Un normale oggetto non diventa iterabile solo perché possiede delle proprietà. Un’implementazione non valida, ad esempio che restituisce un numero invece di un oggetto da next(), causa un TypeError quando si usa il protocollo. Questo meccanismo è sincrono; il protocollo asincrono usa il simbolo distinto Symbol.asyncIterator.

Esempi

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(','));

Risultato

1,2,3
1,2,3

Il codice mostrato e il risultato dichiarato sono stati verificati in un ambiente isolato con il metodo registrato nella prova di verifica di questa versione esatta.

Fonti