Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / JavaScript

Declaração de função geradora e método gerador

Ambas as formas definem funções geradoras síncronas. A declaração associa um nome ao seu âmbito, enquanto o método pertence a um objeto ou a uma classe.

Versão: ECMAScript 2024 and the current web platform; runtime support varies

Sintaxe

function* sequence(start) { yield start; }
const object = { *values() { yield this.start; } };
class Series { *values() { yield this.start; } }

Uma declaração como function* sequence(start) { ... } introduz o nome sequence no seu âmbito. A forma *values() { ... } define um método num objeto ou numa classe: o asterisco precede o nome do método e a palavra-chave function não é usada. Na chamada counter.values(), this tem o valor counter no método.

Cada chamada devolve um novo gerador síncrono, que é simultaneamente um iterador e um objeto iterável. As instruções do corpo só começam a ser executadas na primeira chamada a next(). yield value suspende a execução, preserva o estado local e produz um resultado da forma { value, done: false }. A chamada seguinte a next() retoma a execução. Usar new com qualquer uma das funções lança um TypeError.

Se next() chegar a return value, o resultado é { value, done: true }. Um ciclo for...of e a sintaxe de expansão ... recolhem os valores produzidos por yield, mas omitem o valor final de return. Depois de o gerador terminar, as chamadas seguintes a next() devolvem { value: undefined, done: true }. Para recomeçar, volta a chamar a função ou o método.

Exemplos

{
  function* sequence(start) {
    yield start;
    return start + 1;
  }

  const counter = {
    start: 7,
    *values() {
      yield this.start;
    },
  };

  const steps = sequence(3);
  for (let i = 0; i < 3; i++) {
    const { value, done } = steps.next();
    console.log(`${value} ${done}`);
  }
  console.log(JSON.stringify([...counter.values()]));
}

Resultado

3 false
4 true
undefined true
[7]

As chamadas a `next()` mostram o `3` produzido por `yield`, o `4` devolvido por `return` e, por fim, o estado do gerador esgotado. A expansão do gerador de `counter.values()` produz `[7]`, porque o método lê `counter.start` através de `this`.

Lições relacionadas

  • JavaScript · Lição 8 · Avançado · Versão: 4

Fontes