CKTIS / JavaScript
Odredište zapisivanja WritableStream: start, write, close i abort
Četiri neobavezne metode odredišta određuju kako zapisivi tok priprema odredište, zapisuje dijelove podataka, uredno završava ili nakon prekida oslobađa resurse.
Verzija: 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 pripada API-ju Web Streams, a ne standardu ECMAScript 2024; dostupnost ovisi o izvršnom okruženju. underlyingSink, prvi neobavezni argument konstruktora, objekt je čije metode poziva tok. Drugi neobavezni argument, queuingStrategy, određuje kako se mjeri veličina reda radi reguliranja brzine zapisivanja (backpressure).
start(controller) izvodi se jednom tijekom konstrukcije. Sinkrona iznimka uzrokuje neuspjeh konstrukcije; odbijeno obećanje dovodi stvoreni tok u stanje pogreške. Tok predaje dijelove podataka odredištu tek nakon uspješne inicijalizacije. write(chunk, controller) obrađuje jedan dio odjednom, redoslijedom predaje. Vrati obećanje koje predstavlja stvarno asinkrono zapisivanje kako bi ga tok mogao pričekati i proslijediti pogreške.
close() ne prima argumente. Nakon zahtjeva za zatvaranje poziva se tek kad svi prihvaćeni zapisi uspješno završe. Upotrijebi ga za pražnjenje međuspremnika odredišta i oslobađanje resursa. abort(reason) služi za čišćenje nakon zahtjeva za prekid; razlog može biti bilo koja JavaScript vrijednost. Zapisi koji još nisu počeli odbijaju se, ali operacija u tijeku ne zaustavlja se automatski i završeni se zapisi ne poništavaju. Obje metode mogu vratiti obećanje; nemoj pretpostaviti da će se abort pozvati pri svakoj pogrešci ili nakon zatvaranja.
start i write primaju isti WritableStreamDefaultController. controller.signal omogućuje operaciji u tijeku da reagira na zahtjev za prekid ako podržava otkazivanje. controller.error(error) prijavljuje pogrešku toka; nije zahtjev za prekid i ne zamjenjuje čišćenje.
Proizvođač poziva getWriter(), koji zaključava tok za samo jedan objekt za zapisivanje. Obradi obećanja iz writer.write(), writer.close() i writer.abort(); izravni pozivi stream.close() i stream.abort() vraćaju odbijena obećanja dok je tok zaključan. writer.releaseLock() otključava tok, ali ga ne završava.
Primjeri
(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)
Primjer koristi dva odvojena toka. Oba dovrše zapisivanje `A`; prvi se zatvara, a drugi prekida. Vrijednost `true` pokazuje da je odredište primilo točno isti objekt `Error`.
Povezane lekcije
- JavaScript · Lekcija 4 · Napredno · Verzija: 4
Izvori
- WritableStream: WritableStream() constructor
- WritableStreamDefaultWriter
- WritableStreamDefaultWriter: close() method
- WritableStream: close() method
- WritableStream: abort() method
- WritableStreamDefaultController: signal property
- WritableStreamDefaultController: error() method
- WHATWG Streams Standard — The underlying sink API