CKTIS / JavaScript
Symbol.asyncIterator — protokol asynchrónnej iterácie
Symbol.asyncIterator je vstavaný symbol označujúci metódu, ktorá poskytuje asynchrónny iterátor objektu. Vďaka nemu môže for await...of získavať postupné hodnoty a čakať pritom na výsledky next().
Verzia: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support
Syntax
Symbol.asyncIterator
object[Symbol.asyncIterator]()
async *[Symbol.asyncIterator]() { /* yield values */ }Symbol.asyncIterator je známy symbol používaný ako kľúč vlastnosti, nie funkcia, ktorú možno priamo volať. Metóda object[Symbol.asyncIterator]() vracia asynchrónny iterátor — samotný objekt iterátora, nie prísľub iterátora. Tento mechanizmus je súčasťou ECMAScriptu od ECMAScript 2018 (ES2018); nejde o Web API.
Asynchrónne iterovateľný objekt poskytuje túto metódu, zatiaľ čo asynchrónny iterátor poskytuje metódu next(), ktorá vracia prísľub výsledného objektu. Ak vlastnosť done chýba, výsledok sa vyhodnotí tak, ako keby obsahoval done: false. Výsledok s done: true označuje koniec iterácie a nemusí obsahovať vlastnosť value. Syntax async *[Symbol.asyncIterator]() definuje metódu asynchrónneho generátora, ktorá tento protokol zabezpečuje automaticky.
Cyklus for await...of najprv hľadá Symbol.asyncIterator. Ak metóda chýba alebo má hodnotu null, použije Symbol.iterator a prispôsobí synchrónny iterátor. Bežný cyklus for...of symbol Symbol.asyncIterator nepoužíva. Továrenskú metódu iterátora nedeklarujte ako obyčajnú metódu async: vracala by prísľub namiesto iterátora.
V príklade každé volanie metódy vytvorí nový generátor a cyklus zhromažďuje hodnoty v poradí. Overte podporu syntaxe a symbolu v cieľovom prostredí; samotná prítomnosť Symbol.asyncIterator ani použitie Node 24 v repozitári nedokazujú kompatibilitu s prehliadačmi.
Príklady
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);Výsledok
1, 2, 3
Zobrazený kód a uvedený výsledok boli overené v izolovanom prostredí metódou zaznamenanou v dôkaze o overení tej presnej verzie.