CKTIS / JavaScript
Генераторна функция: function*
Генераторната функция създава итератор, чието изпълнение може да се спре при yield и да се възобнови чрез next(). Тя изчислява стойности при поискване и запазва локалното състояние между последователните стъпки.
Версия: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support
Синтаксис
function* name(parameters) {
yield value;
return finalValue;
}Декларацията function* name(parameters) { ... } дефинира генераторна функция. Извикването ѝ създава нов обект Generator, но все още не изпълнява тялото на функцията. Всеки обект има собствено състояние на изпълнение; първият next() стартира тялото, а yield value подава стойност и спира изпълнението.
Следващ next() възобновява изпълнението след yield, като запазва локалните променливи. Резултатът има полета value и done: yield дава done: false, а return finalValue приключва генератора с done: true. Без изричен return крайната стойност е undefined. След приключването следващите извиквания на next() връщат value: undefined и done: true.
Обектът генератор е едновременно итератор и итерируем обект. for...of и синтаксисът за разгъване (...) в литералите за масиви и в списъците с аргументи при извикване на функции използват стойностите от yield, но пропускат крайната стойност от return. В обектните литерали разгъването не възобновява изпълнението на генератора, а копира собствените му изброими свойства. Изчерпан генератор не може да се стартира отново; вместо това извикайте функцията повторно. Аргументът на next(value) става резултат от спрения израз yield; аргументът на първия next() се игнорира.
Можете да дефинирате генератор и с израз като const make = function* () { yield 1; };, при който името на функцията не е задължително. Няма синтаксис за генераторна стрелкова функция. MDN класифицира function* като широко достъпен в браузърите от септември 2016 г.; проверете отделно поддръжката в целевия браузър.
Примери
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(", "));Резултат
10 | false 20 | false 30 | true undefined | true 10, 20
Показаният код и заявеният резултат са проверени в изолирана среда по метода, записан в доказателството за проверка на тази точна версия.