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

CKTIS / JavaScript

Symbol.iterator — el protocolo de iteración síncrona

Symbol.iterator es el símbolo conocido que identifica un método que produce un iterador. Permite que un objeto personalizado funcione con for...of y la sintaxis de propagación de arrays. Un iterable proporciona un iterador, que a su vez ofrece resultados sucesivos mediante 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

iterable[Symbol.iterator]()
({ [Symbol.iterator]() { return iterator; } })

Symbol.iterator es un símbolo conocido, no una función. Es la clave del método [Symbol.iterator]() de un objeto iterable. Este método devuelve un iterador que utilizan, entre otros, for...of y la sintaxis de propagación de arrays ([...iterable]). La clave de cadena "Symbol.iterator" no es la misma clave.

Un iterable proporciona este método, mientras que un iterador tiene un método next(). Cada llamada a next() debe devolver un objeto de resultado: done indica si la iteración ha terminado, y value contiene el elemento actual mientras continúa la iteración. Cuando done: true, consumidores como for...of no procesan value como un elemento. Tener únicamente next() no convierte un objeto en iterable.

En el ejemplo, cada llamada a [Symbol.iterator]() crea un contador independiente. Por eso, ambas expansiones producen 1,2,3. Un iterador no tiene por qué ser iterable; para que lo sea, puede proporcionar [Symbol.iterator]() y devolver this. Devolver el mismo iterador no garantiza que la iteración vuelva a empezar.

Un objeto ordinario no se vuelve iterable por el mero hecho de tener propiedades. Una implementación no válida, como devolver un número en vez de un objeto desde next(), provoca un TypeError al usar el protocolo. Este mecanismo es síncrono; el protocolo asíncrono utiliza el símbolo independiente Symbol.asyncIterator.

Ejemplos

const numbers = {
  [Symbol.iterator]() {
    let current = 1;
    return {
      next() {
        if (current <= 3) {
          return { value: current++, done: false };
        }
        return { done: true };
      }
    };
  }
};

console.log([...numbers].join(','));
console.log([...numbers].join(','));

Resultado

1,2,3
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