kotlin-web/web.streams/ReadableStreamDefaultController

ReadableStreamDefaultController

open class ReadableStreamDefaultController<R : ERROR CLASS: Symbol not found for JsAny??> : ReadableStreamController<R> (source)

The ReadableStreamDefaultController interface of the Streams API represents a controller allowing control of a ReadableStream's state and internal queue. Default controllers are for streams that are not byte streams.

MDN Reference

Properties

desiredSize

val desiredSize: Double?

The desiredSize read-only property of the ReadableStreamDefaultController interface returns the desired size required to fill the stream's internal queue.

Functions

fun close()

The close() method of the ReadableStreamDefaultController interface closes the associated stream.

enqueue

fun enqueue(chunk: R)

The enqueue() method of the ReadableStreamDefaultController interface enqueues a given chunk in the associated stream.

error

fun error(error: JsError = definedExternally)

The error() method of the ReadableStreamDefaultController interface causes any future interactions with the associated stream to error.