Znalostná bázaCentrum skúšok
SKSlovenčina
Vybrať jazyk13

CKTIS / JavaScript

Cieľ zápisu WritableStream: start, write, close a abort

Štyri voliteľné metódy cieľa určujú, ako zapisovateľný prúd pripraví cieľ, zapíše časti dát, riadne dokončí zápis alebo uvoľní prostriedky po prerušení.

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

Syntax

new WritableStream()
new WritableStream(underlyingSink)
new WritableStream(underlyingSink, queuingStrategy)

// Optional methods on underlyingSink:
const underlyingSink = {
  start(controller) { /* initialize the destination */ },
  write(chunk, controller) { /* write one chunk */ },
  close() { /* finalize successful output */ },
  abort(reason) { /* clean up after an abort request */ },
};

WritableStream patrí do Web Streams API, nie do ECMAScriptu 2024; dostupnosť závisí od prostredia, v ktorom kód beží. underlyingSink, prvý voliteľný argument konštruktora, je objekt, ktorého metódy volá prúd. Druhý voliteľný argument queuingStrategy určuje, ako sa meria veľkosť frontu na reguláciu tempa zápisu (backpressure).

start(controller) sa volá raz počas konštrukcie. Synchrónna výnimka spôsobí zlyhanie konštrukcie; zamietnutý prísľub uvedie vytvorený prúd do chybového stavu. Prúd odovzdá časti dát cieľu až po úspešnej inicializácii. write(chunk, controller) spracúva vždy jednu časť v poradí zadania. Vráť prísľub zodpovedajúci skutočnému asynchrónnemu zápisu, aby naň prúd mohol počkať a postúpiť prípadnú chybu.

close() nedostáva žiadne argumenty. Po požiadavke na zatvorenie sa volá až vtedy, keď všetky prijaté zápisy úspešne skončia. Slúži na vyprázdnenie vyrovnávacích pamätí cieľa a uvoľnenie prostriedkov. abort(reason) upratuje po požiadavke na prerušenie; dôvodom môže byť ľubovoľná hodnota JavaScriptu. Zápisy, ktoré sa ešte nezačali, sa zamietnu, ale prebiehajúca operácia sa automaticky nezastaví a dokončené zápisy sa nevrátia späť. Obe metódy môžu vrátiť prísľub; nespoliehaj sa na to, že sa abort zavolá pri každej chybe alebo po zatvorení.

start a write dostávajú rovnaký WritableStreamDefaultController. controller.signal umožňuje prebiehajúcej operácii reagovať na požiadavku na prerušenie, ak podporuje zrušenie. controller.error(error) oznámi chybu prúdu; nejde o požiadavku na prerušenie a nenahrádza upratovanie.

Producent volá getWriter(), čím zamkne prúd pre jediný zapisovač. Spracuj prísľuby z writer.write(), writer.close() a writer.abort(); priame volania stream.close() a stream.abort() vrátia zamietnuté prísľuby, kým je prúd zamknutý. writer.releaseLock() uvoľní zámok bez ukončenia prúdu.

Príklady

(async () => {
  const log = [];
  const reason = new Error("stop");

  async function run(label, shouldAbort) {
    const stream = new WritableStream({
      start() {
        log.push(`${label}: start`);
      },
      async write(chunk) {
        await Promise.resolve();
        log.push(`${label}: write ${chunk}`);
      },
      close() {
        log.push(`${label}: close`);
      },
      abort(received) {
        log.push(`${label}: abort (${received === reason})`);
      },
    });

    const writer = stream.getWriter();
    try {
      await writer.write("A");
      if (shouldAbort) {
        await writer.abort(reason);
      } else {
        await writer.close();
      }
    } finally {
      writer.releaseLock();
    }
  }

  await run("normal", false);
  await run("interrupted", true);
  console.log(log.join("\n"));
})().catch(console.error);

Výsledok

normal: start
normal: write A
normal: close
interrupted: start
interrupted: write A
interrupted: abort (true)

Príklad používa dva samostatné prúdy. Oba dokončia zápis `A`; prvý sa zatvorí a druhý sa preruší. Hodnota `true` ukazuje, že cieľ dostal presne ten istý objekt `Error`.

Súvisiace lekcie

  • JavaScript · Lekcia 4 · Pokročilá · Verzia: 4

Zdroje