Saltar al contenido
Iteradores y generadores

El protocolo iterable

Lección 1 de 411 min4 ejercicios

for...of recorre arrays, textos, Map y Set sin importar cómo guarda cada uno sus datos. ¿Cómo lo hace? Porque todos cumplen un mismo acuerdo, el protocolo iterable. Si tu objeto lo cumple, funciona con for...of, spread y todo lo demás, como uno más.

Qué mirar en el pizarrón

El array y su iterador son dos objetos distintos. Fíjate en que el iterador recuerda su posición y en qué devuelve cada next(), sobre todo el último.

En el pizarrón

const colores = ["rojo", "verde"];const it = colores[Symbol.iterator](); console.log(it.next());console.log(it.next());console.log(it.next());

Variables

  1. colores→ array #1
  2. array #1[ 'rojo', 'verde' ]
Consola(vacía)

Un array es iterable: tiene un método especial, guardado bajo la clave Symbol.iterator, que sabe fabricar un recorrido.

Con el foco aquí también puedes avanzar y retroceder con las flechas del teclado.

Ver todos los pasos en texto
  1. Paso 1: Un array es iterable: tiene un método especial, guardado bajo la clave Symbol.iterator, que sabe fabricar un recorrido. Variables: colores → array #1, array #1 [ 'rojo', 'verde' ].
  2. Paso 2: Llamar a ese método devuelve un iterador: un objeto aparte, con un método next() y que recuerda por dónde va. El array no cambia. Variables: colores → array #1, array #1 [ 'rojo', 'verde' ], it → iterador #2, iterador #2 posición: 0 · next().
  3. Paso 3: Cada next() devuelve un objeto con dos datos: value, el elemento, y done, si ya terminó. El iterador avanza una posición. Variables: colores → array #1, array #1 [ 'rojo', 'verde' ], it → iterador #2, iterador #2 posición: 1 · next().
  4. Paso 4: Segundo elemento. Todavía done: false: el iterador no sabe que no hay más hasta que lo intenta. Variables: colores → array #1, array #1 [ 'rojo', 'verde' ], it → iterador #2, iterador #2 posición: 2 · next().
  5. Paso 5: done: true: el recorrido terminó, y este iterador ya no sirve. Eso es exactamente lo que hace for...of por dentro: pide el iterador, llama a next() hasta ver done: true y te pasa cada value. Variables: colores → array #1, array #1 [ 'rojo', 'verde' ], it → iterador #2, iterador #2 terminado.

Dos piezas

El protocolo tiene dos partes, como muestra el pizarrón:

  • Un iterable es un objeto que tiene un método bajo la clave Symbol.iterator. Ese método fabrica un iterador.
  • Un iterador es un objeto con un método next(). Cada llamada devuelve { value, done }: el siguiente valor, y si ya se terminó.
const texto = "ok";
const it = texto[Symbol.iterator]();

console.log(it.next());
console.log(it.next());
console.log(it.next());

Symbol.iterator es uno de los símbolos conocidos que viste en Symbols: una clave especial que el lenguaje usa para pedirle algo a un objeto.

Quién usa el protocolo

Todas estas herramientas piden un iterador y llaman a next() hasta ver done: true:

const conjunto = new Set(["a", "b", "c"]);

for (const x of conjunto) console.log(x);    // for...of
console.log([...conjunto]);                  // spread
const [primero, segundo] = conjunto;         // desestructuración de arrays
console.log(primero, segundo);
console.log(Array.from(conjunto));           // Array.from
console.log(new Map([["k", 1]]).get("k"));   // el constructor de Map recibe un iterable
console.log(Math.max(...new Set([3, 9, 4]))); // spread en argumentos

Son iterables los arrays, los textos (por caracteres), Map, Set, los arrays tipados, arguments y los resultados de entries(), keys() y values(). Los objetos literales no lo son.

Hacer iterable un objeto

Basta con darle un método [Symbol.iterator] que devuelva un iterador:

const playlist = {
  canciones: ["Intro", "Tema 1", "Final"],
  [Symbol.iterator]() {
    let i = 0;
    const lista = this.canciones;
    return {
      next() {
        if (i < lista.length) {
          return { value: `♪ ${lista[i++]}`, done: false };
        }
        return { value: undefined, done: true };
      },
    };
  },
};

for (const c of playlist) console.log(c);
console.log([...playlist].length);

La posición (i) se crea dentro del método, así que cada recorrido empieza desde el principio.

Iteradores que también son iterables

Los iteradores del lenguaje (los de entries(), keys(), values()…) tienen también un [Symbol.iterator] que se devuelve a sí mismo. Por eso puedes recorrerlos con for...of, aunque solo una vez:

const it = ["x", "y"].values();

console.log([...it]);  // [ 'x', 'y' ]
console.log([...it]);  // []: ya se consumió

Resumen

  • Un iterable tiene [Symbol.iterator](), que devuelve un iterador.
  • Un iterador tiene next(), que devuelve { value, done }.
  • for...of, spread, desestructuración, Array.from y new Map/Set usan el protocolo.
  • Tus objetos son iterables si implementan [Symbol.iterator].
  • Un iterable se recorre muchas veces; un iterador, una sola.

¡A practicar!

Tu progreso se guarda en este navegador.

Autoevaluación: Iterables e iteradores

Elige una respuesta en cada pregunta.

  1. ¿Qué hace que un objeto sea iterable?

  2. ¿Qué devuelve el next() de un iterador?

  3. ¿Cuál de estas herramientas no usa el protocolo iterable?

  4. ¿Se puede recorrer dos veces el mismo iterador?

Ordena la salida: Un rango iterable

Un objeto propio que cumple el protocolo, usado de cuatro formas. Ordena lo que aparecería en la consola.

const rango = {  desde: 1,  hasta: 3,  [Symbol.iterator]() {    let actual = this.desde;    const hasta = this.hasta;    return {      next() {        return actual <= hasta          ? { value: actual++, done: false }          : { value: undefined, done: true };      },    };  },}; console.log([...rango].join(","));const [primero] = rango;console.log(primero);console.log(Math.max(...rango));console.log(Array.from(rango, (n) => n * 10).at(-1));

Consola, de arriba abajo

  1. 3
  2. 1,2,3
  3. 30
  4. 1

Detective: Un iterador que no avisa el final

Los tres números se imprimen y después todo falla. Encuentra la línea del iterador que hay que arreglar.

Consola

1
2
3
cuenta.js:13
for (const x of cuenta) console.log(x);
                ^

TypeError: Iterator result undefined is not an object

Paso 1: toca la línea de código que causa el error.

Laboratorio: Una cuenta regresiva iterable

Escribe cuentaRegresiva(desde), que devuelva un objeto iterable, implementando el protocolo a mano.

programa.jsse ejecuta mientras escribes

$ node programa.js

(escribe tu código: se ejecuta solo)

Lo que debe cumplir

  • Imprime [ 3, 2, 1 ] (pendiente)
  • Se puede recorrer más de una vez (pendiente)
  • Sin generadores: implementa Symbol.iterator y next (pendiente)

    domina-js · JavaScript en español, gratis y paso a paso.