Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / JavaScript

Protokol iterátoru: next(), return(), value a done

Konec iterace poznáš podle `done`, nikoli podle `value`. Zjisti, jak přečíst koncovou hodnotu a kdy `for...of` volá volitelnou metodu `return()`.

Verze: ECMAScript 2024 and the current web platform; runtime support varies

Syntaxe

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();
}

Synchronní iterátor je objekt s metodou next(), která vrací objekt výsledku (IteratorResult). Iterovatelný objekt má metodu [Symbol.iterator](), která vrací iterátor. Samotná metoda next() neznamená, že je objekt iterovatelný; objekt generátoru plní obě role. for...of získá iterátor a volá next() bez argumentů. Význam případného argumentu závisí na implementaci iterátoru.

Při done: false je value prvek, i když má hodnotu undefined. done: true označuje konec iterace; value pak může obsahovat koncovou hodnotu, kterou for...of nepředává do těla cyklu. Chybějící done se bere jako false; for...of tuto vlastnost při testu převádí na logickou hodnotu. Po vyčerpání iterátoru by další volání next() měla nadále hlásit done: true, jazyk to však nevynucuje.

Volitelná metoda return(value) oznamuje, že volající končí, a dává iterátoru možnost uvolnit prostředky. Výsledek obvykle obsahuje done: true a předaný argument jako value, ale generátor může vrátit done: false, pokud v bloku finally provede yield. Při předčasném opuštění cyklu pomocí break nebo kvůli výjimce z jeho těla zavolá for...of existující return() bez argumentů a ignoruje done i value výsledku. Nevolá ho při běžném vyčerpání iterátoru ani tehdy, když výjimku vyvolá samotné next().

Ruční volání next() iterátor automaticky neuzavírá. Pokud skončíš předčasně, zavolej return(), pokud je volatelné. for...of vyvolá TypeError, pokud next() nebo uzavírací volání return() nevrátí objekt. Jestliže uzavírání vyvolala výjimka z těla cyklu, má původní výjimka přednost.

Příklady

{
  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"));
}

Výsledek

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

Tři samostatné generátory ukazují běžné vyčerpání s koncovou hodnotou `end`, automatické uzavření při `break` a výslovné volání `return("stopped")`. Každý spuštěný generátor vypíše v bloku `finally` text `cleanup`.

Související lekce

  • JavaScript · Lekce 8 · Pokročilá · Verze: 4

Zdroje