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

CKTIS / JavaScript

Cíl zápisu WritableStream: start, write, close a abort

Čtyři volitelné metody cíle určují, jak zapisovatelný proud připraví cíl, zapíše části dat, řádně dokončí zápis nebo uvolní prostředky po přerušení.

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

Syntaxe

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 patří do Web Streams API, nikoli do ECMAScriptu 2024; dostupnost závisí na běhovém prostředí. underlyingSink, první volitelný argument konstruktoru, je objekt, jehož metody volá proud. Druhý volitelný argument queuingStrategy určuje, jak se měří velikost fronty pro regulaci tempa zápisu (backpressure).

start(controller) se volá jednou během konstrukce. Synchronní výjimka způsobí selhání konstrukce; zamítnutý příslib uvede vytvořený proud do chybového stavu. Proud předá části dat cíli až po úspěšné inicializaci. write(chunk, controller) zpracovává vždy jednu část v pořadí zadání. Vrať příslib odpovídající skutečnému asynchronnímu zápisu, aby na něj proud mohl počkat a předat případnou chybu dál.

close() nedostává žádné argumenty. Po požadavku na zavření se volá, až když všechny přijaté zápisy úspěšně skončí. Slouží k vyprázdnění vyrovnávacích pamětí cíle a uvolnění prostředků. abort(reason) uklízí po požadavku na přerušení; důvodem může být libovolná hodnota JavaScriptu. Zápisy, které ještě nezačaly, se zamítnou, ale probíhající operace se automaticky nezastaví a dokončené zápisy se nevrátí zpět. Obě metody mohou vrátit příslib; nespoléhej na to, že se abort zavolá při každé chybě nebo po zavření.

start a write dostávají stejný WritableStreamDefaultController. controller.signal umožňuje probíhající operaci reagovat na požadavek na přerušení, pokud podporuje zrušení. controller.error(error) ohlásí chybu proudu; nejde o požadavek na přerušení a nenahrazuje úklid.

Producent volá getWriter(), čímž zamkne proud pro jediný zapisovač. Zpracuj přísliby z writer.write(), writer.close() a writer.abort(); přímá volání stream.close() a stream.abort() vracejí zamítnutý příslib, dokud je proud uzamčený. writer.releaseLock() zámek uvolní, ale proud neukončí.

Pří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ýsledek

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

Příklad používá dva samostatné proudy. Oba dokončí zápis `A`; první se zavře a druhý se přeruší. Hodnota `true` ukazuje, že cíl dostal přesně tentýž objekt `Error`.

Související lekce

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

Zdroje