Base de conocimientosCentro de exámenes
ESEspañol
Elegir idioma13

CKTIS / JavaScript

Symbol.asyncIterator — el protocolo de iteración asíncrona

Symbol.asyncIterator es un símbolo integrado que identifica el método que proporciona el iterador asíncrono de un objeto. Permite que for await...of obtenga valores sucesivos mientras espera los resultados de next().

Versión: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support

Sintaxis

Symbol.asyncIterator
object[Symbol.asyncIterator]()
async *[Symbol.asyncIterator]() { /* yield values */ }

Symbol.asyncIterator es un símbolo conocido que se usa como clave de propiedad, no una función que se invoque directamente. El método object[Symbol.asyncIterator]() devuelve un iterador asíncrono: el propio objeto iterador, no una promesa que contenga un iterador. Este mecanismo forma parte de ECMAScript desde ECMAScript 2018 (ES2018); no es una API web.

Un objeto iterable asíncrono proporciona este método, mientras que un iterador asíncrono proporciona next(), que devuelve una promesa que se resuelve con un objeto de resultado. Si falta la propiedad done, el resultado se interpreta como si tuviera done: false. Un resultado con done: true indica el fin de la iteración y puede omitir la propiedad value. La sintaxis async *[Symbol.asyncIterator]() define un método de generador asíncrono que gestiona este protocolo automáticamente.

El bucle for await...of busca primero Symbol.asyncIterator. Si el método no existe o tiene el valor null, usa Symbol.iterator y adapta el iterador síncrono. Un for...of normal no usa Symbol.asyncIterator. No declares la fábrica del iterador como un método async normal: devolvería una promesa en lugar de un iterador.

En el ejemplo, cada llamada al método crea un generador nuevo y el bucle recopila los valores en orden. Comprueba la compatibilidad con la sintaxis y el símbolo en el entorno de destino; ni la mera presencia de Symbol.asyncIterator ni el uso de Node 24 en el repositorio demuestran la compatibilidad con los navegadores.

Ejemplos

const numbers = {
  async *[Symbol.asyncIterator]() {
    yield 1;
    yield 2;
    yield 3;
  }
};

async function main() {
  const values = [];
  for await (const value of numbers) {
    values.push(value);
  }
  console.log(values.join(', '));
}

main().catch(console.error);

Resultado

1, 2, 3

El código mostrado y el resultado declarado se verificaron en un entorno aislado mediante el método registrado en la evidencia de verificación de esta versión exacta.

Fuentes