generator.return

return()方法返回给定的值并结束生成器。

语法

gen.return(value)

参数

value需要返回的值

返回值

返回该函数参数中给定的值.

示例

使用 return()

以下例子展示了一个简单的生成器和 return 方法的使用.

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 }

如果return(value)在已经处于“completed”状态的generator被调用，则generator将保持“completed”状态。如果没有任何参数，则返回对象与.next()相同。如果提供了参数，它将被设置为value返回对象的属性的值。

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 }

规范

浏览器支持