Base di conoscenzaCentro esami
ITItaliano
Scegli la lingua13

CKTIS / JavaScript

Symbol.asyncIterator — il protocollo di iterazione asincrona

Symbol.asyncIterator è un simbolo integrato che identifica il metodo che fornisce l’iteratore asincrono di un oggetto. Consente a for await...of di recuperare valori successivi attendendo i risultati di 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

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

Symbol.asyncIterator è un simbolo noto usato come chiave di proprietà, non una funzione da chiamare direttamente. Il metodo object[Symbol.asyncIterator]() restituisce un iteratore asincrono: l’oggetto iteratore stesso, non una promessa che contiene un iteratore. Questo meccanismo fa parte di ECMAScript da ECMAScript 2018 (ES2018); non è una Web API.

Un oggetto iterabile asincrono fornisce questo metodo, mentre un iteratore asincrono fornisce next(), che restituisce una promessa che si risolve con un oggetto risultato. Se la proprietà done è assente, il risultato viene interpretato come se contenesse done: false. Un risultato con done: true segnala la fine dell’iterazione e può omettere la proprietà value. La sintassi async *[Symbol.asyncIterator]() definisce un metodo generatore asincrono che gestisce automaticamente questo protocollo.

Il ciclo for await...of cerca prima Symbol.asyncIterator. Se il metodo è assente o ha valore null, usa Symbol.iterator e adatta l’iteratore sincrono. Un normale ciclo for...of non usa Symbol.asyncIterator. Non dichiarare la fabbrica dell’iteratore come un normale metodo async: restituirebbe una promessa invece di un iteratore.

Nell’esempio, ogni chiamata al metodo crea un nuovo generatore e il ciclo raccoglie i valori in ordine. Verifica il supporto della sintassi e del simbolo nell’ambiente di destinazione; né la sola presenza di Symbol.asyncIterator né l’uso di Node 24 nel repository dimostrano la compatibilità con i browser.

Esempi

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);

Risultato

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