Geradores JavaScript (function*) são funções especiais que podem ser pausadas e retomadas com yield.
Conceitos básicos de geradores: function* e yield
Uma função geradora retorna um objeto gerador que implementa o protocolo Iterator.
// Generator function syntax: function* with yield
function* counter(start = 0) {
let i = start;
while (true) {
yield i++; // pauses here, returns i, resumes on next()
}
}
const gen = counter(1);
console.log(gen.next()); // { value: 1, done: false }
console.log(gen.next()); // { value: 2, done: false }
console.log(gen.next()); // { value: 3, done: false }
// Finite generator
function* range(start, end, step = 1) {
for (let i = start; i < end; i += step) {
yield i;
}
}
// for...of automatically calls .next() and stops at done: true
for (const num of range(0, 10, 2)) {
console.log(num); // 0, 2, 4, 6, 8
}
// Spread operator works with generators
const nums = [...range(1, 6)]; // [1, 2, 3, 4, 5]
// Destructuring works too
const [a, b, c] = range(10, 20); // a=10, b=11, c=12Comunicação bidirecional: yield como expressão
yield não é apenas return — é uma expressão que recebe um valor via next(value).
// Generators support two-way communication
// yield receives values via next(value)
function* calculator() {
let result = 0;
while (true) {
const input = yield result; // pauses and sends result; receives input
if (input === null) break;
result += input;
}
return result;
}
const calc = calculator();
calc.next(); // start: { value: 0, done: false }
calc.next(10); // add 10: { value: 10, done: false }
calc.next(5); // add 5: { value: 15, done: false }
calc.next(null); // stop: { value: 15, done: true }
// Generator as stateful iterator
function* idGenerator(prefix = 'id') {
let id = 1;
while (true) {
const reset = yield `${prefix}-${id}`;
if (reset) {
id = 1;
} else {
id++;
}
}
}
const ids = idGenerator('user');
console.log(ids.next().value); // 'user-1'
console.log(ids.next().value); // 'user-2'
console.log(ids.next(true).value); // 'user-1' (reset)
console.log(ids.next().value); // 'user-2'yield*: delegar para outros iteráveis
yield* delega para outro iterável.
// yield* — delegate to another iterable
function* innerGen() {
yield 'a';
yield 'b';
yield 'c';
}
function* outerGen() {
yield 1;
yield* innerGen(); // delegate: yields 'a', 'b', 'c'
yield* [4, 5, 6]; // works with any iterable
yield 7;
}
console.log([...outerGen()]); // [1, 'a', 'b', 'c', 4, 5, 6, 7]
// Practical: flatten nested arrays
function* flatten(arr) {
for (const item of arr) {
if (Array.isArray(item)) {
yield* flatten(item); // recursive delegation
} else {
yield item;
}
}
}
const nested = [1, [2, [3, 4], 5], [6, 7]];
console.log([...flatten(nested)]); // [1, 2, 3, 4, 5, 6, 7]
// Tree traversal with yield*
function* walkTree(node) {
yield node.value;
for (const child of node.children ?? []) {
yield* walkTree(child); // depth-first traversal
}
}Geradores assíncronos: streaming de dados
Geradores assíncronos combinam geradores com async/await para streaming.
// Async generators: async function* with yield
async function* streamLines(url) {
const response = await fetch(url);
const reader = response.body.getReader();
const decoder = new TextDecoder();
let buffer = '';
while (true) {
const { done, value } = await reader.read();
if (done) {
if (buffer) yield buffer;
break;
}
buffer += decoder.decode(value, { stream: true });
const lines = buffer.split('\n');
buffer = lines.pop() ?? '';
for (const line of lines) {
yield line; // yield each complete line
}
}
}
// Usage with for await...of
async function processCSV(url) {
let lineNumber = 0;
for await (const line of streamLines(url)) {
lineNumber++;
if (lineNumber === 1) continue; // skip header
const [name, score] = line.split(',');
console.log(`${name}: ${score}`);
}
}
// SSE (Server-Sent Events) as async generator
async function* sseStream(url) {
const response = await fetch(url);
const reader = response.body.getReader();
const decoder = new TextDecoder();
for await (const chunk of readChunks(reader)) {
const text = decoder.decode(chunk);
for (const line of text.split('\n')) {
if (line.startsWith('data: ')) {
yield JSON.parse(line.slice(6));
}
}
}
}Padrões do mundo real
Geradores permitem pipelines preguiçosas que processam apenas os dados necessários.
// Real-world: infinite scroll with generator
function* paginator(fetchPage) {
let page = 1;
let hasMore = true;
while (hasMore) {
const { items, totalPages } = yield fetchPage(page);
hasMore = page < totalPages;
page++;
}
}
// Lazy pipeline with generators
function* map(iterable, fn) {
for (const item of iterable) {
yield fn(item);
}
}
function* filter(iterable, predicate) {
for (const item of iterable) {
if (predicate(item)) yield item;
}
}
function* take(iterable, n) {
let count = 0;
for (const item of iterable) {
if (count++ >= n) break;
yield item;
}
}
// Lazy pipeline — no intermediate arrays created!
const first10EvenSquares = [
...take(
filter(
map(range(1, Infinity), x => x * x),
x => x % 2 === 0
),
10
)
];
// [4, 16, 36, 64, 100, 144, 196, 256, 324, 400]
// Observable-like: cancelable async iteration
async function* withTimeout(asyncIterable, timeoutMs) {
const timeout = setTimeout(() => {
throw new Error('Stream timed out');
}, timeoutMs);
try {
for await (const item of asyncIterable) {
yield item;
}
} finally {
clearTimeout(timeout);
}
}Geradores vs alternativas
| Feature | Generator | async/await | Promise | Observable |
|---|---|---|---|---|
| Infinite sequences | Perfect | No | No | Yes |
| Lazy evaluation | Yes (pull-based) | No | No | Yes (push) |
| Backpressure | Natural (pull) | No | No | Yes |
| Streaming async | async function* | No | No | Yes (RxJS) |
| Two-way comms | yield expression | No | No | No |
| Browser support | ES2015+ (all) | ES2017+ | ES2015+ | Requires RxJS |
Boas práticas
- Geradores para sequências preguiçosas, async/await para operações únicas.
- Usar return para saída antecipada, try/finally para limpeza.
- Geradores assíncronos perfeitos para HTTP streaming, SSE, WebSocket.
- Criar helpers de pipeline reutilizáveis (map, filter, take).
- TypeScript: anotar com Generator para segurança de tipos.
FAQ
Diferença entre gerador e iterador?
Um iterador é qualquer objeto com next(). Um gerador cria e gerencia um iterador automaticamente.
Geradores podem substituir async/await?
Para operações únicas, não. Para streaming, geradores assíncronos são superiores.
O que é o protocolo Iterator?
Um objeto com next() retornando { value, done }, e [Symbol.iterator]() para iteráveis.
Geradores são bons para Redux-Saga?
Sim — Redux-Saga os usa para efeitos testáveis.
Como cancelar um gerador?
Chamar generator.return(value) ou usar break em for...of.