CKTIS / JavaScript
Funkcja generatorowa: function*
Funkcja generatorowa (generator function) tworzy iterator, którego wykonanie można wstrzymywać przez yield i wznawiać przez next(). Pozwala obliczać wartości na żądanie, zachowując lokalny stan między kolejnymi krokami.
Wersja: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support
Składnia
function* name(parameters) {
yield value;
return finalValue;
}Deklaracja function* name(parameters) { ... } definiuje funkcję generatorową. Wywołanie tworzy nowy obiekt Generator, ale nie wykonuje jeszcze ciała funkcji. Każdy taki obiekt ma własny stan wykonania; pierwsze next() uruchamia ciało, a yield value przekazuje wartość i wstrzymuje wykonanie.
Kolejne next() wznawia wykonanie po yield, zachowując zmienne lokalne. Wynik ma pola value i done: yield daje done: false, a return finalValue kończy generator z done: true. Bez jawnego return wartością końcową jest undefined. Po zakończeniu dalsze next() zwraca value: undefined i done: true.
Obiekt generatora jest zarówno iteratorem, jak i obiektem iterowalnym. for...of oraz składnia rozwinięcia (...) w literałach tablic i listach argumentów wywołań funkcji pobierają wartości z yield, ale pomijają końcową wartość z return. Rozwinięcie w literałach obiektów nie wznawia działania generatora, lecz kopiuje jego własne wyliczalne właściwości. Zużytego generatora nie można uruchomić od początku; należy ponownie wywołać funkcję. Argument next(value) staje się wynikiem wstrzymanego wyrażenia yield; argument pierwszego next() jest ignorowany.
Generator można też zdefiniować wyrażeniem const make = function* () { yield 1; };, w którym nazwa funkcji jest opcjonalna. Nie istnieje generatorowa składnia funkcji strzałkowej. MDN klasyfikuje function* jako szeroko dostępne w przeglądarkach od września 2016 roku; wsparcie docelowej przeglądarki należy sprawdzić osobno.
Przykłady
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(", "));Wynik
10 | false 20 | false 30 | true undefined | true 10, 20
Wyświetlony kod i zadeklarowany wynik zweryfikowano w odizolowanym środowisku metodą zapisaną w dowodzie weryfikacji tej dokładnej wersji.