kotlin-web/web.streams/TransformStreamDefaultController

TransformStreamDefaultController

open class TransformStreamDefaultController<in O : ERROR CLASS: Symbol not found for JsAny??>(source)

The TransformStreamDefaultController interface of the Streams API provides methods to manipulate the associated ReadableStream and WritableStream.

MDN Reference

Properties

desiredSize

val desiredSize: Double?

The desiredSize read-only property of the TransformStreamDefaultController interface returns the desired size to fill the queue of the associated ReadableStream.

Functions

enqueue

fun enqueue(chunk: O)

The enqueue() method of the TransformStreamDefaultController interface enqueues the given chunk in the readable side of the stream.

error

fun error(reason: JsError? = definedExternally)

The error() method of the TransformStreamDefaultController interface errors both sides of the stream. Any further interactions with it will fail with the given error message, and any chunks in the queue will be discarded.

terminate

fun terminate()

The terminate() method of the TransformStreamDefaultController interface closes the readable side and errors the writable side of the stream.