--- title: function* slug: Web/JavaScript/Reference/Statements/function* tags: - Declaración - Experimental - Expérimental(2) - Iterador - función translation_of: Web/JavaScript/Reference/Statements/function* original_slug: Web/JavaScript/Referencia/Sentencias/function* ---
La declaración function*
(la palabra clave function
seguida de un asterisco) define una función generadora, que devuelve un objeto {{jsxref("Global_Objects/Generator","Generator")}}.
También puedes definir funciones generadoras usando el constructor {{jsxref("GeneratorFunction")}} y una {{jsxref("Operators/function*", "function* expression")}}.
function* nombre([param[, param[, ... param]]]) { instrucciones }
nombre
param
instrucciones
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 , el cuerpo de la función generadora es ejecutado hasta la primera expresión {{jsxref("Operators/yield", "yield")}}, la cual especifica el valor que será retornado por el iterador o con, {{jsxref("Operators/yield*", "yield*")}}, delega a otra función generadora. El método next()
retorna un objeto con una propiedad value que contiene el valor bajo el operador yield y una propiedad done que indica, con un booleano, si la función generadora ha hecho yield al último valor.
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 // ...
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 | Status | Comentarios |
---|---|---|
{{SpecName('ES2015', '#', 'function*')}} | {{Spec2('ES2015')}} | Initial definition. |
Característica | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
---|---|---|---|---|---|
Soporte básico | {{CompatChrome(39.0)}} | {{CompatGeckoDesktop("26.0")}} | {{CompatNo}} | 26 | {{CompatNo}} |
yield* |
{{CompatVersionUnknown}} | {{CompatGeckoDesktop("27.0")}} | {{CompatNo}} | 26 | {{CompatNo}} |
IteratorResult object instead of throwing |
{{CompatVersionUnknown}} | {{CompatGeckoDesktop("29.0")}} | {{CompatNo}} | {{CompatVersionUnknown}} | {{CompatNo}} |
Característica | Android | Chrome for Android | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|---|
Soporte básico | {{CompatVersionUnknown}} | {{CompatChrome(39.0)}} | {{CompatGeckoMobile("26.0")}} | {{CompatNo}} | {{CompatNo}} | {{CompatNo}} |
yield* |
{{CompatVersionUnknown}} | {{CompatVersionUnknown}} | {{CompatGeckoMobile("27.0")}} | {{CompatNo}} | {{CompatNo}} | {{CompatNo}} |
IteratorResult object instead of throwing |
{{CompatUnknown}} | {{CompatVersionUnknown}} | {{CompatGeckoMobile("29.0")}} | {{CompatNo}} | {{CompatNo}} | {{CompatNo}} |
Las versiones anteriores de FireFox implementan así mismo una versión anterior de la propuesta de generadores. En la versión anterior, los generadores eran definidos utilizando la declaración function
de una manera regular (Sin asterisco). Véase Legacy generator function para mayor información.
IteratorResult
object returned instead of throwingStarting with Gecko 29 {{geckoRelease(29)}}, the completed generator function no longer throws a {{jsxref("TypeError")}} "generator has already finished". Instead, it returns an IteratorResult
object like { value: undefined, done: true }
({{bug(958951)}}).