CKTIS / JavaScript
Protokół iteratora: next(), return(), value i done
Sprawdzaj `done`, a nie `value`, aby rozpoznać koniec iteracji. Dowiedz się, jak odczytać wynik końcowy i kiedy `for...of` wywołuje opcjonalne `return()`.
Wersja: ECMAScript 2024 and the current web platform; runtime support varies
Składnia
const iterator = iterable[Symbol.iterator]();
const result = iterator.next();
// result.done: completion flag; result.value: element or completion value
// When stopping early during manual iteration, call the optional method if callable:
if (typeof iterator.return === "function") {
iterator.return();
}Synchroniczny iterator to obiekt z metodą next(), która zwraca obiekt wyniku (IteratorResult). Obiekt iterowalny udostępnia metodę [Symbol.iterator](), która zwraca iterator. Samo next() nie czyni obiektu iterowalnym; generator pełni obie role. for...of pobiera iterator i wywołuje next() bez argumentów. Znaczenie ewentualnego argumentu zależy od implementacji iteratora.
done: false oznacza, że value jest elementem, nawet jeśli wynosi undefined. done: true oznacza koniec; value może wtedy zawierać wynik końcowy, którego for...of nie przekazuje do ciała pętli. Brak done jest traktowany jak false, a for...of interpretuje tę właściwość po konwersji na wartość logiczną. Po zakończeniu kolejne wywołania next() powinny nadal zwracać done: true, ale język tego nie wymusza.
Opcjonalna metoda return(value) sygnalizuje, że wywołujący nie zamierza już pobierać elementów, i pozwala zwolnić zasoby. Zwykle zwraca done: true i przekazany argument jako value, ale generator może zwrócić done: false, jeśli wykona yield w bloku finally. Przy przedwczesnym wyjściu przez break albo wyjątek z ciała pętli for...of wywołuje dostępne return() bez argumentów i nie korzysta z jego done ani value. Nie wywołuje go po zwykłym wyczerpaniu iteratora ani gdy samo next() zgłosi wyjątek.
Własne wywołania next() nie zapewniają automatycznego zamknięcia: przy wcześniejszym przerwaniu samodzielnie wywołaj return(), jeśli jest funkcją. for...of zgłasza TypeError, gdy next() lub wywołane przy zamykaniu return() zwróci coś innego niż obiekt. Jeśli zamykanie następuje po wyjątku z ciała pętli, pierwszeństwo ma pierwotny wyjątek.
Przykłady
{
function* sequence() {
try {
yield undefined;
return "end";
} finally {
console.log("cleanup");
}
}
function show(label, { done, value }) {
console.log(`${label}: done=${done}, value=${value}`);
}
const full = sequence();
show("next", full.next());
show("next", full.next());
show("next", full.next());
for (const value of sequence()) {
console.log(`loop: ${value}`);
break;
}
const manual = sequence();
manual.next();
show("return", manual.return("stopped"));
}Wynik
next: done=false, value=undefined cleanup next: done=true, value=end next: done=true, value=undefined loop: undefined cleanup cleanup return: done=true, value=stopped
Trzy osobne generatory pokazują zwykłe wyczerpanie z wynikiem `end`, automatyczne zamknięcie przez `break` i jawne `return("stopped")`. Każdy uruchomiony generator wypisuje `cleanup` w bloku `finally`.
Powiązane lekcje
- JavaScript · Lekcja 8 · Zaawansowany · Wersja: 4