CKTIS / JavaScript
Generátorová funkce: function*
Generátorová funkce vytváří iterátor, jehož vykonávání lze pozastavit na yield a pokračovat v něm pomocí next(). Hodnoty počítá podle potřeby a mezi jednotlivými kroky zachovává lokální stav.
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
function* name(parameters) {
yield value;
return finalValue;
}Deklarace function* name(parameters) { ... } definuje generátorovou funkci. Jejím zavoláním vznikne nový objekt Generator, tělo funkce se však ještě nevykoná. Každý objekt má vlastní stav vykonávání; první next() spustí tělo a yield value předá hodnotu a pozastaví vykonávání.
Další next() pokračuje ve vykonávání za příkazem yield a zachovává lokální proměnné. Výsledek má pole value a done: yield vrací done: false, zatímco return finalValue ukončí generátor s done: true. Bez výslovného return je konečnou hodnotou undefined. Po dokončení vracejí další volání next() hodnoty value: undefined a done: true.
Objekt generátoru je zároveň iterátor i iterovatelný objekt. for...of a syntaxe spread (...) v literálech polí a v seznamech argumentů při volání funkcí zpracují hodnoty z yield, ale vynechají konečnou hodnotu z return. V objektových literálech syntaxe spread neposouvá generátor dál, ale kopíruje jeho vlastní vyčíslitelné vlastnosti. Vyčerpaný generátor nelze spustit znovu; místo toho zavolejte funkci znovu. Argument next(value) se stane výsledkem pozastaveného výrazu yield; argument prvního next() se ignoruje.
Generátor lze definovat také výrazem, například const make = function* () { yield 1; };, kde je název funkce nepovinný. Syntaxe generátorových šipkových funkcí neexistuje. MDN klasifikuje function* jako široce dostupné v prohlížečích od září 2016; podporu cílového prohlížeče ověřte zvlášť.
Příklady
function* steps() {
yield 10;
yield 20;
return 30;
}
const iterator = steps();
for (let i = 0; i < 4; i++) {
const { value, done } = iterator.next();
console.log(`${value} | ${done}`);
}
console.log([...steps()].join(", "));Výsledek
10 | false 20 | false 30 | true undefined | true 10, 20
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.