WritableStream
The WritableStream interface of the Streams API provides a standard abstraction for writing streaming data to a destination, known as a sink. This object comes with built-in backpressure and queuing.
Type Parameters
| Type Parameter | Default type |
|---|---|
W | any |
Methods
abort()
abort(reason?): Promise<void>;
The abort() method of the WritableStream interface aborts the stream, signaling that the producer can no longer successfully write to the stream and it is to be immediately moved to an error state, with any queued writes discarded.
Parameters
| Parameter | Type |
|---|---|
reason? | any |
Returns
Promise<void>
close()
close(): Promise<void>;
The close() method of the WritableStream interface closes the associated stream. All chunks written before this method is called are sent before the returned promise is fulfilled.
Returns
Promise<void>
getWriter()
getWriter(): WritableStreamDefaultWriter<W>;
The getWriter() method of the WritableStream interface returns a new instance of WritableStreamDefaultWriter and locks the stream to that instance. While the stream is locked, no other writer can be acquired until this one is released.
Returns
WritableStreamDefaultWriter<W>
Properties
locked
readonly locked: boolean;
The locked read-only property of the WritableStream interface returns a boolean indicating whether the WritableStream is locked to a writer.