CKTIS / JavaScript
Symbol.iterator — synchrónny iteračný protokol
Symbol.iterator je známy symbol označujúci metódu, ktorá vytvára iterátor. Vďaka nemu môže vlastný objekt spolupracovať s for...of a rozbalením poľa. Iterovateľný objekt poskytuje iterátor a ten postupne vracia výsledky pomocou next().
Verzia: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support
Syntax
iterable[Symbol.iterator]()
({ [Symbol.iterator]() { return iterator; } })Symbol.iterator je známy symbol, nie funkcia. Je kľúčom metódy [Symbol.iterator]() iterovateľného objektu (iterable). Táto metóda vracia iterátor, ktorý používajú okrem iného for...of a rozbalenie poľa ([...iterable]). Reťazcový kľúč "Symbol.iterator" nie je rovnakým kľúčom.
Iterovateľný objekt poskytuje túto metódu, zatiaľ čo iterátor má metódu next(). Každé volanie next() musí vrátiť objekt s výsledkom: done určuje, či sa iterácia skončila, a value obsahuje aktuálny prvok, kým iterácia pokračuje. Pri done: true používatelia ako for...of nespracúvajú value ako prvok. Samotná metóda next() z objektu iterovateľný objekt neurobí.
V príklade vytvorí každé volanie [Symbol.iterator]() samostatné počítadlo. Obe rozbalenia preto vytvoria 1,2,3. Iterátor nemusí byť sám iterovateľný; ak ním má byť, môže poskytovať [Symbol.iterator]() vracajúce this. Vrátenie toho istého iterátora nezaručuje, že sa iterácia začne odznova.
Bežný objekt sa nestane iterovateľným len preto, že má vlastnosti. Neplatná implementácia, napríklad taká, ktorá z next() vracia číslo namiesto objektu, spôsobí pri použití protokolu chybu TypeError. Tento mechanizmus je synchrónny; asynchrónny protokol používa samostatný symbol Symbol.asyncIterator.
Príklady
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(','));Výsledok
1,2,3 1,2,3
Zobrazený kód a uvedený výsledok boli overené v izolovanom prostredí metódou zaznamenanou v dôkaze o overení tejto presnej verzie.