В ES6 были введены генераторные функции, которые могут приостанавливать поток выполнения функции с помощью ключевого слова `yield`, что позволяет изменять поток выполнения и тем самым предоставляет решение для асинхронного программирования. Базовое использование

Композиция генераторных функций

У генератора есть две части, которые отличают его от обычных функций:

  • Одна из них заключается в том, что после `function` и перед именем функции ставится `*`;

  • Внутри функции находится выражение `yield`.

Среди них `*` используется для указания, что функция является генераторной, а `yield` — для определения внутреннего состояния функции.

function* func(){ console.log("one"); yield '1'; console.log("two"); yield '2'; console.log("three"); return '3'; }

Механизм выполнения

Вызов функции-генератора аналогичен вызову обычной функции: просто добавьте круглые скобки после имени функции. Однако функция-генератор не выполняется сразу, как обычная функция; вместо этого она возвращает указатель на внутренний объект состояния. Поэтому, чтобы вызвать метод `next` объекта-итератора, указатель начнёт выполнение с начала функции или с того места, где он остановился в последний раз.

f.next(); // one // {value: "1", done: false} f.next(); // two // {value: "2", done: false} f.next(); // three // {value: "3", done: true} f.next(); // {value: undefined, done: true}

При первом вызове метода `next` выполнение начинается с начала функции-генератора. Сначала выводится `one`, затем оно останавливается при достижении `yield` и использует значение выражения после `yield`, `'1'`, как свойство `value` возвращаемого объекта. На этом этапе функция ещё не завершила выполнение, поэтому свойство `done` возвращаемого объекта равно `false`.

При втором вызове метода `next` всё происходит так же, как на предыдущем шаге.

При третьем вызове метода `next` сначала выводится `three`, затем выполняется операция `return` функции, и значение выражения после `return` используется как свойство `value` возвращаемого объекта. На этом этапе функция завершилась, поэтому значение свойства `done` равно `true`.

При четвёртом вызове метода `next` функция уже завершила выполнение, поэтому она возвращает `undefined` как значение свойства `value` и `true` как значение свойства `done`. Если бы на третьем шаге не было оператора `return`, она бы непосредственно вернула `{value: undefined, done: true}`.

Методы объекта-итератора, возвращаемого функцией

метод `next`

В общем, когда метод `next` вызывается без аргументов, возвращаемым значением выражения `yield` является `undefined`. Когда в `next` передаётся аргумент, этот аргумент служит возвращаемым значением предыдущего `yield`.

function* sendParameter(){ console.log("start"); var x = yield '2'; console.log("one:" + x); var y = yield '3'; console.log("two:" + y); console.log("total:" + (x + y)); }

Вызов `next` без аргументов

var sendp1 = sendParameter(); sendp1.next(); // start // {value: "2", done: false} sendp1.next(); // one:undefined // {value: "3", done: false} sendp1.next(); // two:undefined // total:NaN // {value: undefined, done: true} nextПередача аргументовvar sendp2 = sendParameter(); sendp2.next(10); // start // {value: "2", done: false} sendp2.next(20); // one:20 // {value: "3", done: false} sendp2.next(30); // two:30 // total:50 // {value: undefined, done: true}

Помимо использования `next`, вы также можете использовать цикл `for...of` для перебора объекта-итератора, сгенерированного функцией-генератором.

метод `return`

Метод `return` возвращает заданное значение и завершает итерацию функции-генератора.

Когда методу `return` передан аргумент, он возвращает этот аргумент; когда аргумент не передан, он возвращает `undefined`.

function* foo(){ yield 1; yield 2; yield 3; } var f = foo(); f.next(); // {value: 1, done: false} f.return("foo"); // {value: "foo", done: true} f.next(); // {value: undefined, done: true} throwMethodthrowМетод можетGeneratorвыбросить исключение вне тела функции и перехватить его внутри тела функции.var g = function* () { try { yield; } catch (e) { console.log('catch inner', e); } }; var i = g(); i.next(); try { i.throw('a'); i.throw('b'); } catch (e) { console.log('catch outside', e); } // catch inner a // catch outside b

Объект-итератор выбрасывает две ошибки. Первая перехватывается внутри функции-генератора. Вторая, поскольку `catch` внутри тела функции уже выполнился, не будет перехвачена снова, поэтому эта ошибка выбрасывается из тела функции-генератора и перехватывается `catch` вне тела функции.

Выражение `yield*`

Выражение `yield*` означает, что `yield` возвращает объект-итератор, который используется для вызова другой функции-генератора внутри функции-генератора.

function* callee() { console.log('callee: ' + (yield)); } function* caller() { while (true) { yield* callee(); } } const callerObj = caller(); callerObj.next(); // {value: undefined, done: false} callerObj.next("a"); // callee: a // {value: undefined, done: false} callerObj.next("b"); // callee: b // {value: undefined, done: false} //Эквивалентно function* caller() { while (true) { for (var value of callee) { yield value; } } }

Сценарии использования

Реализация Iterator

Предоставляет метод обхода для объектов, не имеющих интерфейса Iterator.

function* objectEntries(obj) { const propKeys = Reflect.ownKeys(obj); for (const propKey of propKeys) { yield [propKey, obj[propKey]]; } } const jane = { first: 'Jane', last: 'Doe' }; for (const [key,value] of objectEntries(jane)) { console.log(`${ключ}: ${значение}`); } // first: Jane // last: Doe

`Reflect.ownKeys()` возвращает все свойства объекта, независимо от того, являются ли свойства перечисляемыми, включая символы.

`jane` изначально не имеет интерфейса Iterator и не может быть перебран с помощью `for...of`. Здесь используется функция-генератор, чтобы добавить интерфейс Iterator, поэтому объект `jane` может быть перебран.