kotlin-web/web.streams/WritableStreamDefaultWriter

WritableStreamDefaultWriter

open class WritableStreamDefaultWriter<W : JsAny?>(stream: WritableStream<W>)(source)

The WritableStreamDefaultWriter interface of the Streams API is the object returned by WritableStream.getWriter() and once created locks the writer to the WritableStream ensuring that no other streams can write to the underlying sink.

MDN Reference

Constructors

Link copied to clipboard
constructor(stream: WritableStream<W>)

Properties

Link copied to clipboard
val closed: Promise<Void>

The closed read-only property of the the stream errors or the writer's lock is released.

Link copied to clipboard
val desiredSize: Double?

The desiredSize read-only property of the to fill the stream's internal queue.

Link copied to clipboard
val ready: Promise<Void>

The ready read-only property of the that resolves when the desired size of the stream's internal queue transitions from non-positive to positive, signaling that it is no longer applying backpressure.

Functions

Link copied to clipboard
inline suspend fun <W : JsAny?> WritableStreamDefaultWriter<W>.abort()
inline suspend fun <W : JsAny?> WritableStreamDefaultWriter<W>.abort(reason: JsError?)

The abort() method of the 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.

Link copied to clipboard
fun abortAsync(reason: JsError? = definedExternally): Promise<Void>

The abort() method of the 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.

Link copied to clipboard
inline suspend fun <W : JsAny?> WritableStreamDefaultWriter<W>.close()

The close() method of the stream.

Link copied to clipboard
fun closeAsync(): Promise<Void>

The close() method of the stream.

Link copied to clipboard
fun releaseLock()

The releaseLock() method of the corresponding stream.

Link copied to clipboard
inline suspend fun <W : JsAny?> WritableStreamDefaultWriter<W>.write()
inline suspend fun <W : JsAny?> WritableStreamDefaultWriter<W>.write(chunk: W)

The write() method of the operation.

Link copied to clipboard
fun writeAsync(chunk: W = definedExternally): Promise<Void>

The write() method of the operation.