CKTIS / JavaScript
Symbol.iterator — sinhroni iteracijski protokol
Symbol.iterator je dobro znani simbol, ki označuje metodo za ustvarjanje iteratorja. Omogoča, da lastni objekt deluje z for...of in razširitvijo polja. Iterabilni objekt zagotovi iterator, ta pa prek next() zaporedoma zagotavlja rezultate.
Različica: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support
Sintaksa
iterable[Symbol.iterator]()
({ [Symbol.iterator]() { return iterator; } })Symbol.iterator je dobro znani simbol, ne funkcija. Je ključ metode [Symbol.iterator]() iterabilnega objekta (iterable). Ta metoda vrne iterator, ki ga med drugim uporabljata for...of in razširitev polja ([...iterable]). Nizovni ključ "Symbol.iterator" ni isti ključ.
Iterabilni objekt zagotovi to metodo, iterator pa ima metodo next(). Vsak klic next() mora vrniti objekt z rezultatom: done pove, ali je iteracija končana, value pa vsebuje trenutni element, dokler se iteracija nadaljuje. Pri done: true uporabniki, kot je for...of, vrednosti value ne obravnavajo kot elementa. Sam obstoj metode next() objekta ne naredi iterabilnega.
V primeru vsak klic [Symbol.iterator]() ustvari ločen števec. Zato obe razširitvi ustvarita 1,2,3. Iteratorju ni treba biti samemu iterabilen; če naj bo, lahko zagotovi [Symbol.iterator]() in vrne this. Vrnitev istega iteratorja ne zagotavlja, da se iteracija začne znova.
Običajen objekt ne postane iterabilen zgolj zato, ker ima lastnosti. Neveljavna izvedba, na primer taka, ki iz next() vrne število namesto objekta, pri uporabi protokola povzroči TypeError. Ta mehanizem je sinhron; asinhroni protokol uporablja ločen simbol Symbol.asyncIterator.
Primeri
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(','));Rezultat
1,2,3 1,2,3
Prikazana koda in navedeni rezultat sta bila preverjena v izoliranem okolju z metodo, zapisano v dokazilu o preverjanju te natančne različice.