Generator.prototype.return()

Baseline Widely available

This feature is well established and works across many devices and browser versions. Its been available across browsers since septiembre de 2016.

Learn more
See full compatibility

El mtodo return() regresa el valor dado y finaliza al generador.

Sintaxis

gen.return(valor)

Ejemplos

Utilizando `return()`

El siguiente ejemplo muestra un generador simple y su mtodo 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 }

Si return(valor) es invocado en un generador que ya est en su estado "completado", el generador permanecer en estado "completado". Si no se da ningn argumento, el objeto regresado es el mismo a que si se invocara .next(). Si se da un argumento, ste se asignar como valor en la propiedad value del objeto regresado.

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 }