CKTIS / JavaScript
Generatorska funkcija: function*
Generatorska funkcija ustvari iterator, katerega izvajanje se lahko ustavi pri yield in nadaljuje z next(). Vrednosti izračunava po potrebi ter med zaporednimi koraki ohranja lokalno stanje.
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
function* name(parameters) {
yield value;
return finalValue;
}Deklaracija function* name(parameters) { ... } določa generatorsko funkcijo. Klic ustvari nov objekt Generator, vendar telesa funkcije še ne izvede. Vsak objekt ima svoje stanje izvajanja; prvi next() zažene telo, yield value pa posreduje vrednost in ustavi izvajanje.
Naslednji next() nadaljuje izvajanje za yield in ohrani lokalne spremenljivke. Rezultat ima polji value in done: yield povzroči done: false, medtem ko return finalValue konča generator z done: true. Brez izrecnega return je končna vrednost undefined. Po koncu nadaljnji klici next() vrnejo value: undefined in done: true.
Objekt generatorja je hkrati iterator in iterabilen objekt. for...of in sintaksa spread (...) v literalih polj in na seznamih argumentov pri klicih funkcij uporabita vrednosti iz yield, izpustita pa končno vrednost iz return. V objektnih literalih sintaksa spread ne nadaljuje izvajanja generatorja, temveč kopira njegove lastne naštevne lastnosti. Izčrpanega generatorja ni mogoče znova zagnati; namesto tega znova pokličite funkcijo. Argument za next(value) postane rezultat ustavljenega izraza yield; argument prvega next() se prezre.
Generator lahko določite tudi z izrazom, kot je const make = function* () { yield 1; };, pri katerem je ime funkcije neobvezno. Sintaksa generatorske puščične funkcije ne obstaja. MDN uvršča function* med široko podprte funkcionalnosti v brskalnikih od septembra 2016; podporo ciljnega brskalnika preverite posebej.
Primeri
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(", "));Rezultat
10 | false 20 | false 30 | true undefined | true 10, 20
Prikazana koda in navedeni rezultat sta bila preverjena v izoliranem okolju z metodo, zapisano v dokazilu o preverjanju te natančne različice.