The return()
method returns the given value and finishes the generator.
Syntax
gen.return(value)
Parameters
value
- The value to return.
Return value
The value that is given as an argument.
Examples
Using return()
The following example shows a simple generator and the return
method.
function* gen() { yield 1; yield 2; yield 3; } var g = gen(); g.next(); // { value: 1, done: false } g.return('foo'); // { value: "foo", done: true } g.next(); // { value: undefined, done: true }
If return(value)
is called on a generator that is already in "completed" state, the generator will remain in "completed" state. If no argument is provided, the return object is the same as if .next()
. If an argument is provided, it will be set to the value of the value
property of the returned object.
function* gen() { yield 1; yield 2; yield 3; } var g = gen(); g.next(); // { value: 1, done: false } g.next(); // { value: 2, done: false } g.next(); // { value: 3, done: false } g.next(); // { value: undefined, done: true } g.return(); // { value: undefined, done: true } g.return(1); // { value: 1, done: true }
Specifications
Specification | Status | Comment |
---|---|---|
ECMAScript 2015 (6th Edition, ECMA-262) The definition of 'Generator.prototype.return' in that specification. |
Standard | Initial definition. |
ECMAScript Latest Draft (ECMA-262) The definition of 'Generator.prototype.return' in that specification. |
Draft |
Browser compatibility
Feature | Chrome | Edge | Firefox (Gecko) | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|---|
Basic support | 50 | 13 | 38 (38) | No support | 37 | 10 |
Feature | Android | Chrome for Android | Edge | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|---|---|
Basic support | No support | 50 | (Yes) | 38.0 (38) | ? | ? | 10 |
See also
Document Tags and Contributors
Tags:
Contributors to this page:
jameshkramer,
rwaldron,
foolifish07,
nmve,
kdex,
Dennis.li,
David_Gilbertson,
eduardoboucas,
panhezeng,
fscholz
Last updated by:
jameshkramer,