Delegated yield (yield star, yield *) in generator functions
Delegating to another generator means the current generator stops producing values by itself, instead yielding the values produced by another generator until it exhausts it. It then resumes producing its own values, if any.
For instance, if secondGenerator()
produces numbers from 10
to 15
, and firstGenerator()
produces numbers from 1
to 5
but delegates to secondGenerator()
after producing 2
, then the values produced by firstGenerator()
will be:
1, 2, 10, 11, 12, 13, 14, 15, 3, 4, 5
function* firstGenerator() {
yield 1;
yield 2;
// Delegate to second generator
yield* secondGenerator();
yield 3;
yield 4;
yield 5;
}
function* secondGenerator() {
yield 10;
yield 11;
yield 12;
yield 13;
yield 14;
yield 15;
}
console.log(Array.from(firstGenerator()));
Delegated yield doesn't have to delegate to another generator only, but to any iterator, so the first answer is a bit inconclusive. Consider this simple example:
function* someGenerator() {
yield 0;
yield [1,2,3];
yield* [1,2,3];
}
for (v of someGenerator()) {
console.log(v);
}
There isn't another function inside the generator itself - yet yield* [1, 2, 3]
delegates to the Array.prototype[@@iterator]
method.
function *gimme1to2_10to15_3to5() {
var ten = gimme10to15();
yield 1; yield 2;
for (var i = 10; i <= 20; i++)
yield *ten;
yield 3; yield 4; yield 5;
}
function *gimme10to15() {
for (var i = 10; i <= 15; i++)
var x = yield i;
}
let gen = gimme1to2_10to15_3to5();
var ar = [];
for (var i = 0; i < 12; i++)
{
var r = gen.next();
ar [i] = r.value + (r.done ? "!" : "..");
}
console.log (ar.join (", "));
The result is
1.., 2.., 10.., 11.., 12.., 13.., 14.., 15.., 3.., 4.., 5.., undefined!
Notes
The function with yield * asks for 11 values from the inner generator but only receives the 10..15 that it should. The excess yield * calls have no effect.
The done value of the inner generator has no effect on the done that its caller returns.
The output shows undefined! at the end because the testing loop is written to go one beyond the required number of values in order to show the generator's done = true
This output is from the ES6 testing ground, Babel, and the semantics exhibited above should be considered provisional as at 5th Feb 2016.