Генератор

Объект Generator возвращается функцией-генератором и соответствует как протоколу итерируемого объекта, так и протоколу итератора.

Generator является подклассом класса Iterator.

Конструктор

В JavaScript нет сущности, соответствующей конструктору Generator. Экземпляры Generator должны возвращаться из функций-генераторов:

function* generator() {
  yield 1;
  yield 2;
  yield 3;
}

const gen = generator(); // "Generator { }"

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

Существует только скрытый объект, который является прототипом, общим для всех объектов, созданных функциями-генераторами. Этот объект часто стилизуют как Generator.prototype, чтобы он выглядел как класс, но более правильно его назвать GeneratorFunction.prototype.prototype, потому что GeneratorFunction является реальной сущностью JavaScript. Чтобы понять цепочку прототипов экземпляров Generator, см. GeneratorFunction.prototype.prototype.

Свойства экземпляра

Эти свойства определены в Generator.prototype и общие для всех экземпляров Generator.

Generator.prototype.constructor

Конструктор, создавший экземпляр объекта. Для экземпляров Generator начальным значением является GeneratorFunction.prototype.

Примечание: Объекты Generator не хранят ссылку на функцию-генератор, которая их создала.

Generator.prototype[Symbol.toStringTag]

Начальным значением свойства [Symbol.toStringTag] является строка "Generator". Это свойство используется в Object.prototype.toString().

Методы экземпляра

Также наследует методы экземпляра от родительского Iterator.

Generator.prototype.next()

Возвращает значение, выданное выражением yield.

Generator.prototype.return()

Действует так, как будто оператор return вставлен в тело генератора в текущей приостановленной позиции, что завершает генератор и позволяет ему выполнить любые задачи очистки при совместном использовании с блоком try...finally.

Generator.prototype.throw()

Действует так, как будто оператор throw вставлен в тело генератора в текущей приостановленной позиции, что информирует генератор о возникновении ошибки и позволяет ему обработать ошибку, или выполнить очистку и закрыть себя.

Примеры

Бесконечный итератор

С функцией-генератором значения не вычисляются до тех пор, пока они не понадобятся. Следовательно, генератор позволяет нам определить потенциально бесконечную структуру данных.

function* infinite() {
  let index = 0;

  while (true) {
    yield index++;
  }
}

const generator = infinite(); // "Generator { }"

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

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

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

См. также

• function*
• function* expression
• GeneratorFunction
• Протоколы итерации