Baza znanjaIzpitno središče
SLSlovenščina
Izberi jezik13

CKTIS / JavaScript

Protokol iteratorja: next(), return(), value in done

Za zaznavanje konca iteracije preveri `done`, ne `value`. Nauči se prebrati končno vrednost in ugotovi, kdaj `for...of` pokliče neobvezno metodo `return()`.

Različica: ECMAScript 2024 and the current web platform; runtime support varies

Sintaksa

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

Sinhroni iterator je objekt z metodo next(), ki vrne objekt z rezultatom (IteratorResult). Iterabilni objekt ima metodo [Symbol.iterator](), ki vrne iterator. Samo metoda next() še ne pomeni, da je objekt iterabilen; objekt generatorja ima obe vlogi. for...of pridobi iterator in pokliče next() brez argumentov. Pomen morebitnega argumenta je odvisen od implementacije iteratorja.

Pri done: false je value element, tudi če je njegova vrednost undefined. done: true pomeni konec iteracije; value lahko takrat vsebuje končno vrednost, ki je for...of ne posreduje telesu zanke. Manjkajoči done se obravnava kot false; for...of to lastnost pri preverjanju pretvori v logično vrednost. Ko je iterator izčrpan, naj bi tudi nadaljnji klici next() javljali done: true, vendar jezik tega ne zahteva.

Neobvezna metoda return(value) sporoči, da klicatelj ne bo več iteriral, in iteratorju omogoči sprostitev virov. Rezultat navadno vsebuje done: true in podani argument kot value, generator pa lahko vrne done: false, če v bloku finally izvede yield. Pri predčasnem izhodu z break ali zaradi izjeme v telesu zanke for...of pokliče return() brez argumentov, če metoda obstaja, ter prezre done in value rezultata. Ne pokliče je, če se iterator običajno izčrpa ali če izjemo sproži sam next().

Ročni klici next() iteratorja ne zaprejo samodejno. Če končaš predčasno, sam pokliči return(), če je to mogoče priklicati. for...of sproži TypeError, če next() ali klic return() ob zapiranju ne vrne objekta. Če zapiranje sproži izjema v telesu zanke, ima prvotna izjema prednost.

Primeri

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

Rezultat

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

Trije ločeni generatorji prikažejo običajno izčrpanje s končno vrednostjo `end`, samodejno zapiranje z `break` in izrecni klic `return("stopped")`. Vsak zagnani generator v svojem bloku `finally` izpiše `cleanup`.

Povezane lekcije

  • JavaScript · Lekcija 8 · Napredna · Različica: 4

Viri