Generator.prototype.return()

The return() method returns the given value and finishes the generator.

Syntax

<var>gen</var>.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 }

Note:

if done is true,  return(value) as same as next()，value is undefined.

function* gen() {yield 1;}
var g = gen();
console.log(g.next());//{ value: 1, done: false }
console.log(g.next());//{ value: undefined, done: true }
console.log(g.return(1)); //{ value: undefined, done: true }

Specifications

Browser compatibility

See also

• function*