function*

This is a new technology, part of the ECMAScript 2015 (ES6) standard.
This technology's specification has been finalized, but check the compatibility table for usage and implementation status in various browsers.

La declaración function* (la palabra clave function seguida de una asterisco) define una función generadora, que devuelve un objeto Generator.

También puedes definir funciones generadoras usando el constructor GeneratorFunction y una function* expression.

Sintaxis

function* nombre([param[, param[, ... param]]]) {
   instrucciones
}
nombre
El nombre de la función.
param
El nombre de los argumentos que se le van a pasar a la función. Una función puede tener hasta 255 argumentos.
instrucciones
Las instrucciones que componen el cuerpo de la función.

Descripción

Los generadores son funciones de las que se puede salir y volver a entrar. Su contexto (asociación de variables) será conservado entre las reentradas.

La llamada a una función generadora no ejecuta su cuerpo inmediatamente; se devuelve un objeto iterador para la función en su lugar. Cuando el metodo next() del iterador es llamado , the generator function's body is executed until the first yield expression, which specifies the value to be returned from the iterator or, with yield*, delegates to another generator function. The next() method returns an object with a value property containing the yielded value and a done property which indicates whether the generator has yielded its last value.

Ejemplos

Ejemplo simple

function* idMaker(){
  var index = 0;
  while(index < 3)
    yield index++;
}

var gen = idMaker();

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

Ejemplo con yield*

function* anotherGenerator(i) {
  yield i + 1;
  yield i + 2;
  yield i + 3;
}

function* generator(i){
  yield i;
  yield* anotherGenerator(i);
  yield i + 10;
}

var gen = generator(10);

console.log(gen.next().value); // 10
console.log(gen.next().value); // 11
console.log(gen.next().value); // 12
console.log(gen.next().value); // 13
console.log(gen.next().value); // 20

Especificaciones

Especificaciones Status Comentarios
ECMAScript 2015 (6th Edition, ECMA-262)
The definition of 'function*' in that specification.
Standard Initial definition.

Compatibilidad con navegadores

Característica Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Soporte básico 39.0 26.0 (26.0) No support 26 No support
yield* (Yes) 27.0 (27.0) No support 26 No support
IteratorResult object instead of throwing (Yes) 29.0 (29.0) No support (Yes) No support
Característica Android Chrome for Android Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile
Soporte básico (Yes) 39.0 26.0 (26.0) No support No support No support
yield* (Yes) (Yes) 27.0 (27.0) No support No support No support
IteratorResult object instead of throwing ? (Yes) 29.0 (29.0) No support No support No support

Notas específicas de Firefox

Generadores e iteradores en versiones de Firefox anteriores a 26

Older Firefox versions implement an older version of the generators proposal. In the older version, generators were defined using a regular function keyword (without an asterisk) among other differences. See Legacy generator function for further information.

IteratorResult object returned instead of throwing

Starting with Gecko 29 (Firefox 29 / Thunderbird 29 / SeaMonkey 2.26), the completed generator function no longer throws a TypeError "generator has already finished". Instead, it returns an IteratorResult object like { value: undefined, done: true } (bug 958951).

Ver también

Etiquetas y colaboradores del documento

 Colaboradores en esta página: TheBronx, mrtuto2012, rippe2hl, germanfr
 Última actualización por: TheBronx,