Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / JavaScript

Symbol.asyncIterator — protokol asynchronní iterace

Symbol.asyncIterator je vestavěný symbol označující metodu, která poskytuje asynchronní iterátor objektu. Díky němu může for await...of získávat jednotlivé hodnoty a čekat přitom na výsledky next().

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

Syntaxe

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

Symbol.asyncIterator je známý symbol používaný jako klíč vlastnosti, nikoli funkce, kterou lze přímo volat. Metoda object[Symbol.asyncIterator]() vrací asynchronní iterátor — samotný objekt iterátoru, nikoli příslib iterátoru. Tento mechanismus je součástí ECMAScriptu od ECMAScript 2018 (ES2018); nejde o Web API.

Asynchronně iterovatelný objekt poskytuje tuto metodu, zatímco asynchronní iterátor poskytuje metodu next(), která vrací příslib výsledného objektu. Pokud vlastnost done chybí, výsledek se vyhodnotí stejně, jako kdyby obsahoval done: false. Výsledek s done: true označuje konec iterace a nemusí obsahovat vlastnost value. Syntaxe async *[Symbol.asyncIterator]() definuje metodu asynchronního generátoru, která tento protokol zajišťuje automaticky.

Smyčka for await...of nejprve hledá Symbol.asyncIterator. Pokud metoda chybí nebo má hodnotu null, použije Symbol.iterator a přizpůsobí synchronní iterátor. Běžná smyčka for...of symbol Symbol.asyncIterator nepoužívá. Tovární metodu iterátoru nedeklarujte jako obyčejnou metodu async: vracela by příslib místo iterátoru.

V příkladu každé volání metody vytvoří nový generátor a smyčka shromažďuje hodnoty v pořadí. Ověřte podporu syntaxe a symbolu v cílovém prostředí; samotná přítomnost Symbol.asyncIterator ani použití Node 24 v repozitáři nedokazují kompatibilitu s prohlížeči.

Pří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ýsledek

1, 2, 3

Zobrazený kód a uvedený výsledek byly ověřeny v izolovaném prostředí metodou zaznamenanou v dokladu o ověření této přesné verze.

Zdroje