function*

Сводка

function* (ключевое слово function со звёздочкой) определяет функцию-генератор.

Синтаксис

function* gen(i){
  while(true){
    yield i++;
    yield* anotherGenerator(i);
  }
}

Описание

Генераторы являются функциями с возможностью повторного входа после выхода. Их контекст исполнения (значения переменных) сохраняется при последующих входах.

Когда вызывается функция-генератор, её тело исполняется не сразу; вместо этого возвращается объект-итератор. При вызове метода next() итератора, тело функции-генератора исполняется до первого встреченного оператора yield, который определяет возвращаемое значение или делегирует возврат другому генератору при помощи yield* anotherGenerator(). Метод next() возвращает объект со свойством value, содержащим отданное значение, и свойством done, которое указывает, что генератор уже отдал своё последнее значение.

Примеры

Простой пример

function* idMaker(){
    var index = 0;
    while(true)
        yield index++;
}

var gen = idMaker();

console.log(gen.next().value); // 0
console.log(gen.next().value); // 1
console.log(gen.next().value); // 2
// ...

Спецификации

Совместимость с браузерами

Генераторы и итераторы до версии Firefox 26

В старых версиях Firefox была реализована иная версия генераторов. В ней генераторы определялись обычным ключевым словом function (без звёздочки) и имели некоторые другие отличия.

Смотрите также

• Протокол итераторов
• Оператор yield
• Оператор function
• Другие ресурсы:
  • Компилятор Regenerator из ES6 в ES5
  • Forbes Lindesay: Promises and Generators: control flow utopia -- JSConf EU 2013
  • Task.js