CKTIS / JavaScript
Symbol.iterator — synchronní iterační protokol
Symbol.iterator je známý symbol označující metodu, která vytváří iterátor. Díky němu může vlastní objekt spolupracovat s for...of a rozbalením pole. Iterovatelný objekt poskytuje iterátor a ten postupně vrací výsledky prostřednictvím next().
Verze: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support
Syntaxe
iterable[Symbol.iterator]()
({ [Symbol.iterator]() { return iterator; } })Symbol.iterator je známý symbol, nikoli funkce. Je klíčem metody [Symbol.iterator]() iterovatelného objektu (iterable). Tato metoda vrací iterátor, který používají mimo jiné for...of a rozbalení pole ([...iterable]). Řetězcový klíč "Symbol.iterator" není stejným klíčem.
Iterovatelný objekt poskytuje tuto metodu, zatímco iterátor má metodu next(). Každé volání next() musí vrátit objekt s výsledkem: done určuje, zda je iterace dokončena, a value obsahuje aktuální prvek, dokud iterace pokračuje. Při done: true uživatelé jako for...of nezpracovávají value jako prvek. Samotná metoda next() z objektu iterovatelný objekt neudělá.
V příkladu vytvoří každé volání [Symbol.iterator]() samostatný čítač. Obě rozbalení proto vytvoří 1,2,3. Iterátor nemusí být sám iterovatelný; pokud jím má být, může poskytovat [Symbol.iterator]() vracející this. Vrácení stejného iterátoru nezaručuje, že iterace začne znovu.
Běžný objekt se nestane iterovatelným jen tím, že má vlastnosti. Neplatná implementace, například taková, která z next() vrací číslo místo objektu, způsobí při použití protokolu chybu TypeError. Tento mechanismus je synchronní; asynchronní protokol používá samostatný symbol Symbol.asyncIterator.
Pří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ýsledek
1,2,3 1,2,3
Zobrazený kód a uvedený výsledek byly ověřeny v izolovaném prostředí metodou zaznamenanou v dokladu o ověření této přesné verze.