kotlin-web/web.streams/WritableStream

WritableStream

open class WritableStream<W : JsAny?>(underlyingSink: UnderlyingSink<W> = definedExternally, strategy: QueuingStrategy<W> = definedExternally) : Transferable, AsyncCloseableDisposable(source)

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.

MDN Reference

Constructors

WritableStream

constructor(underlyingSink: UnderlyingSink<W> = definedExternally, strategy: QueuingStrategy<W> = definedExternally)

Properties

locked

val locked: Boolean

The locked read-only property of the WritableStream interface returns a boolean indicating whether the WritableStream is locked to a writer.

Functions

abort

inline suspend fun <W : JsAny?> WritableStream<W>.abort()

inline suspend fun <W : JsAny?> WritableStream<W>.abort(reason: JsError?)

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.

abortAsync

fun abortAsync(reason: JsError? = definedExternally): Promise<Void?>

inline suspend fun <W : JsAny?> WritableStream<W>.close()

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.

closeAsync

fun closeAsync(): 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.

getWriter

fun 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.