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

CKTIS / JavaScript

Cilj zapisovanja WritableStream: start, write, close in abort

Štiri izbirne metode cilja določajo, kako zapisljivi tok pripravi cilj, zapiše kose podatkov, uspešno konča zapisovanje ali po prekinitvi sprosti vire.

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

Sintaksa

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 spada v API Web Streams, ne v ECMAScript 2024; razpoložljivost je odvisna od izvajalnega okolja. underlyingSink, prvi izbirni argument konstruktorja, je objekt, katerega metode kliče tok. Drugi izbirni argument queuingStrategy določa, kako se meri velikost čakalne vrste za uravnavanje hitrosti zapisovanja (backpressure).

start(controller) se izvede enkrat med ustvarjanjem toka. Sinhrona izjema prepreči uspešno ustvarjanje; zavrnjena obljuba spravi ustvarjeni tok v stanje napake. Tok začne posredovati kose podatkov cilju šele po uspešni inicializaciji. write(chunk, controller) obdela po en kos v vrstnem redu oddaje. Vrni obljubo, ki predstavlja dejansko asinhrono zapisovanje, da lahko tok počaka nanjo in posreduje napake.

close() ne prejme argumentov. Po zahtevi za zaprtje se izvede šele, ko so vsi sprejeti zapisi uspeli. Uporabi ga za praznjenje medpomnilnikov cilja in sproščanje virov. abort(reason) poskrbi za čiščenje po zahtevi za prekinitev; razlog je lahko katerakoli vrednost JavaScript. Zapisi, ki se še niso začeli, so zavrnjeni, toda operacija v teku se ne ustavi samodejno, dokončani zapisi pa se ne razveljavijo. Obe metodi lahko vrneta obljubo; ne računaj, da se bo abort izvedel ob vsaki napaki ali po zaprtju.

start in write prejmeta isti WritableStreamDefaultController. controller.signal omogoča, da se operacija v teku odzove na zahtevo za prekinitev, če podpira preklic. controller.error(error) sporoči napako toka; ni zahteva za prekinitev in ne nadomesti čiščenja.

Producent pokliče getWriter(), ki zaklene tok za en sam zapisovalnik. Obravnavaj obljube metod writer.write(), writer.close() in writer.abort(); neposredna klica stream.close() in stream.abort() vrneta zavrnjeno obljubo, dokler je tok zaklenjen. writer.releaseLock() sprosti zaklep, ne da bi končal tok.

Primeri

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

Rezultat

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

Primer uporablja dva ločena tokova. Oba dokončata zapis `A`; prvi se zapre, drugi pa se prekine. Vrednost `true` pomeni, da je cilj prejel natanko isti objekt `Error`.

Povezane lekcije

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

Viri