CKTIS / JavaScript
Função geradora: function*
Uma função geradora cria um iterador cuja execução pode ser suspensa em yield e retomada através de next(). Calcula valores a pedido, preservando o estado local entre passos sucessivos.
Versão: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support
Sintaxe
function* name(parameters) {
yield value;
return finalValue;
}A declaração function* name(parameters) { ... } define uma função geradora. Ao chamá-la, é criado um novo objeto Generator, mas o corpo da função ainda não é executado. Cada objeto tem o seu próprio estado de execução; o primeiro next() inicia o corpo e yield value fornece um valor e suspende a execução.
Outro next() retoma a execução depois de yield, preservando as variáveis locais. O resultado tem os campos value e done: yield produz done: false, enquanto return finalValue termina o gerador com done: true. Sem um return explícito, o valor final é undefined. Depois de terminar, as chamadas seguintes a next() devolvem value: undefined e done: true.
Um objeto gerador é simultaneamente um iterador e um objeto iterável. for...of e a sintaxe spread (...) em literais de array e nas listas de argumentos das chamadas a funções consomem os valores de yield, mas excluem o valor final de return. Em literais de objeto, a sintaxe spread não faz o gerador avançar: copia as propriedades próprias enumeráveis do objeto gerador. Um gerador esgotado não pode ser reiniciado; em vez disso, volte a chamar a função. Um argumento de next(value) passa a ser o resultado da expressão yield suspensa; o argumento do primeiro next() é ignorado.
Também pode definir um gerador com uma expressão como const make = function* () { yield 1; };, em que o nome da função é opcional. Não existe sintaxe de função seta geradora. A MDN classifica function* como amplamente disponível nos navegadores desde setembro de 2016; verifique separadamente o suporte do navegador de destino.
Exemplos
function* steps() {
yield 10;
yield 20;
return 30;
}
const iterator = steps();
for (let i = 0; i < 4; i++) {
const { value, done } = iterator.next();
console.log(`${value} | ${done}`);
}
console.log([...steps()].join(", "));Resultado
10 | false 20 | false 30 | true undefined | true 10, 20
O código apresentado e o resultado declarado foram verificados num ambiente isolado pelo método registado na prova de verificação desta versão exata.