Baza znanjaIzpitno središče
SLSlovenščina
Izberi jezik13

CKTIS / JavaScript

Symbol.asyncIterator — protokol asinhrone iteracije

Symbol.asyncIterator je vgrajeni simbol, ki označuje metodo, s katero objekt zagotovi svoj asinhroni iterator. Tako lahko for await...of pridobiva zaporedne vrednosti in pri tem čaka na rezultate next().

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

Sintaksa

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

Symbol.asyncIterator je znani simbol, ki se uporablja kot ključ lastnosti, ne pa funkcija za neposreden klic. Metoda object[Symbol.asyncIterator]() vrne asinhroni iterator — sam objekt iteratorja, ne obljube, ki bi vsebovala iterator. Ta mehanizem je del ECMAScripta od ECMAScript 2018 (ES2018); ni spletni API.

Asinhrono iterabilen objekt zagotavlja to metodo, asinhroni iterator pa ima metodo next(), ki vrne obljubo, katere izpolnitvena vrednost je objekt z rezultatom. Če lastnosti done ni, se rezultat obravnava, kot da vsebuje done: false. Rezultat z done: true označuje konec iteracije in lahko izpusti lastnost value. Zapis async *[Symbol.asyncIterator]() določa metodo asinhronega generatorja, ki ta protokol obravnava samodejno.

Zanka for await...of najprej poišče Symbol.asyncIterator. Če metode ni ali ima vrednost null, uporabi Symbol.iterator in prilagodi sinhroni iterator. Običajna zanka for...of ne uporablja Symbol.asyncIterator. Tovarniške metode iteratorja ne deklariraj kot navadne metode async: vrnila bi obljubo namesto iteratorja.

V primeru vsak klic metode ustvari nov generator, zanka pa zbira vrednosti po vrsti. Preveri podporo za sintakso in simbol v ciljnem okolju; niti sama prisotnost Symbol.asyncIterator niti uporaba Node 24 v repozitoriju ne dokazujeta združljivosti z brskalniki.

Primeri

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

Rezultat

1, 2, 3

Prikazana koda in navedeni rezultat sta bila preverjena v izoliranem okolju z metodo, zapisano v dokazilu o preverjanju te natančne različice.

Viri