Generador

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2016.

El objeto Generator es retornado por una función generator y es conformado tanto el protocolo iterable como el protocolo iterador.

Constructor

Este objeto no puede ser instanciado directamente. En su lugar, una instancia del objeto Generator puede ser devuelta por una función generator:

js
function* gen() {
  yield 1;
  yield 2;
  yield 3;
}

var g = gen(); // "Generator { }"

Métodos de instanciación

Tambien hereda propiedades de Iterator.

Generator.prototype.next()

Retorna el valor ofrecido por la expresión yield

Generator.prototype.return()

Retorna el valor dado y finaliza el generador.

Generator.prototype.throw()

Lanza un error al generador (también finaliza el generador, a menos que sea atrapado desde ese generador)

Propiedades

Tambien hereda propiedades de Iterator.

Generator.prototype.constructor

Especifica la funciòn que construye el prototipo del objeto.

Generator.prototype[@@toStringTag]

La cadena "Generator".

Ejemplo

Un iterador infinito

js
function* idMaker() {
  var index = 0;
  while (true) yield index++;
}

var gen = idMaker(); // "Generator { }"

console.log(gen.next().value); // 0
console.log(gen.next().value); // 1
console.log(gen.next().value); // 2
// ...

Objetos generadores legados

Firefox(SpiderMonkey) tambén implementa una versión mas temprana de generadores en JavaScript 1.7, donde el asterisco (*) en la declaración de la funcion no era necesario(sólo use la palabra reservada yield en el cuerpo de la función). Sin embargo, los generadores legados se encuentran depreciados. No los use. Serán removidos (Error 1083482 en Firefox).

Métodos de generadores legados

Generator.prototype.next()

Retorna el valor ofrecido por la expresión yield. Esto se corresponde con el método next() en el objeto generador de ES2015.

Generator.prototype.close()

Cierra el generador. Sí el método next() es llamado por la expresión StopIteration, un error será lanzado. Esto se corresponde con el método return() del objeto generador de ES2015.

Generator.prototype.send()

Utilizado para enviar un valor al generador. El valor es retornado por la expresion yield, y retorna el valor ofrecido por la siguiente expresion yield. send(x) Se corresponde a next(x) en el objeto generador de ECMAScript 2015.

Generator.prototype.throw()

Lanza un error al generador. Esto se corresponde con el metodo throw() en el objeto genererador de ES2015.

Ejemplo de generador legado

js
function fibonacci() {
  var a = yield 1;
  yield a * 2;
}

var it = fibonacci();
console.log(it);          // "Generator {  }"
console.log(it.next());   // 1
console.log(it.send(10)); // 20
console.log(it.close());  // undefined
console.log(it.next());   // throws StopIteration (as the generator is now closed)

Especificaciones

Specification
ECMAScript Language Specification
# sec-generator-objects

Compatibilidad con navegadores

BCD tables only load in the browser

Vea también

Generadores Legados

Generadores ES2015