CKTIS / JavaScript
Generátorová funkcia: function*
Generátorová funkcia vytvára iterátor, ktorého vykonávanie možno pozastaviť pri yield a pokračovať v ňom pomocou next(). Hodnoty počíta podľa potreby a medzi jednotlivými krokmi zachováva lokálny stav.
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
function* name(parameters) {
yield value;
return finalValue;
}Deklarácia function* name(parameters) { ... } definuje generátorovú funkciu. Jej zavolaním vznikne nový objekt Generator, telo funkcie sa však ešte nevykoná. Každý objekt má vlastný stav vykonávania; prvé next() spustí telo a yield value odovzdá hodnotu a pozastaví vykonávanie.
Ďalšie next() pokračuje vo vykonávaní za príkazom yield a zachováva lokálne premenné. Výsledok má polia value a done: yield vracia done: false, zatiaľ čo return finalValue ukončí generátor s done: true. Bez výslovného return je konečnou hodnotou undefined. Po dokončení vracajú ďalšie volania next() hodnoty value: undefined a done: true.
Objekt generátora je zároveň iterátor aj iterovateľný objekt. for...of a syntax spread (...) v literáloch polí a v zoznamoch argumentov pri volaní funkcií spracujú hodnoty z yield, ale vynechajú konečnú hodnotu z return. V objektových literáloch syntax spread neposúva generátor ďalej, ale kopíruje jeho vlastné vymenovateľné vlastnosti. Vyčerpaný generátor nemožno spustiť znova; namiesto toho zavolajte funkciu opäť. Argument next(value) sa stane výsledkom pozastaveného výrazu yield; argument prvého next() sa ignoruje.
Generátor možno definovať aj výrazom, napríklad const make = function* () { yield 1; };, kde je názov funkcie nepovinný. Syntax generátorových šípkových funkcií neexistuje. MDN klasifikuje function* ako široko dostupné v prehliadačoch od septembra 2016; podporu cieľového prehliadača overte osobitne.
Prí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ýsledok
10 | false 20 | false 30 | true undefined | true 10, 20
Zobrazený kód a uvedený výsledok boli overené v izolovanom prostredí metódou zaznamenanou v dôkaze o overení tejto presnej verzie.