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.fromynew Map/Setusan 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
Resuelto
Elige una respuesta en cada pregunta.
¿Qué hace que un objeto sea iterable?
¿Qué devuelve el
next()de un iterador?¿Cuál de estas herramientas no usa el protocolo iterable?
¿Se puede recorrer dos veces el mismo iterador?
Ordena la salida: Un rango iterable
Resuelto
Un objeto propio que cumple el protocolo, usado de cuatro formas. Ordena lo que aparecería en la consola.
1const rango = {2 desde: 1,3 hasta: 3,4 [Symbol.iterator]() {5 let actual = this.desde;6 const hasta = this.hasta;7 return {8 next() {9 return actual <= hasta10 ? { value: actual++, done: false }11 : { value: undefined, done: true };12 },13 };14 },15};16 17console.log([...rango].join(","));18const [primero] = rango;19console.log(primero);20console.log(Math.max(...rango));21console.log(Array.from(rango, (n) => n * 10).at(-1));Consola, de arriba abajo
- 3
- 1,2,3
- 30
- 1
Con [Symbol.iterator], el objeto funciona con spread, desestructuración y Array.from. Cada uso llama al método otra vez y obtiene un iterador nuevo, que empieza desde 1.
Detective: Un iterador que no avisa el final
Resuelto
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 objectPaso 1: toca la línea de código que causa el error.
Paso 2: ¿cómo lo arreglas?
Laboratorio: Una cuenta regresiva iterable
Resuelto
Escribe cuentaRegresiva(desde), que devuelva un objeto iterable, implementando el protocolo a mano.
$ node programa.js
Lo que debe cumplir
- Imprime
[ 3, 2, 1 ](pendiente) - Se puede recorrer más de una vez (pendiente)
- Sin generadores: implementa
Symbol.iteratorynext(pendiente)
Una solución
1function cuentaRegresiva(desde) {2 return {3 [Symbol.iterator]() {4 let actual = desde;5 return {6 next() {7 if (actual >= 1) return { value: actual--, done: false };8 return { value: undefined, done: true };9 },10 };11 },12 };13}14 15console.log([...cuentaRegresiva(3)]);La clave para que se pueda recorrer dos veces: la posición (actual) se crea dentro de [Symbol.iterator], así que cada recorrido tiene la suya. Funciona, pero es mucho código para algo simple. En el próximo tema, un generador hace lo mismo en tres líneas.