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

CKTIS / JavaScript

Iteradores e geradores

Um iterador expõe resultados sucessivos através de next(), enquanto um objeto iterável fornece um iterador através de Symbol.iterator. Um gerador facilita a implementação de ambos os mecanismos com function* e yield.

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

iterator.next() // { value, done }
iterable[Symbol.iterator]() // iterator
function* name() { yield value; }

Um iterador é um objeto com um método next() que devolve um objeto de resultado, não o próprio elemento. Um objeto iterável expõe um método [Symbol.iterator]() que devolve um iterador. Ter apenas next() não é, por isso, suficiente para utilizar um objeto em for...of.

O resultado do iterador — iterator result value/done — é descrito pelos campos value e done. Com done: false, value contém o elemento seguinte. Com done: true, a iteração terminou e value pode conter um valor de retorno final. Se done estiver ausente, é considerado false; se value estiver ausente, o resultado é undefined. Não detete o fim comparando value com undefined: esse pode ser um elemento válido.

A chamada de uma função function* cria um gerador que é simultaneamente um iterador e um objeto iterável. next() retoma a execução, yield fornece um elemento e suspende a função, e return termina-a. for...of e a sintaxe spread ... ignoram o valor do resultado com done: true.

Um gerador mantém o seu estado: reutilizá-lo não reinicia a iteração. Volte a chamar a função geradora para iniciar um novo percurso. O exemplo distingue os elementos de yield do valor final de return.

Exemplos

function* numbers() {
  yield 10;
  yield 20;
  return 99;
}

const iterator = numbers();
for (let i = 0; i < 4; i++) {
  const { value, done } = iterator.next();
  console.log(`${String(value)} | ${done}`);
}
console.log([...numbers()].join(", "));

Resultado

10 | false
20 | false
99 | 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.

Fontes