kotlin-web/web.streams/ReadableByteStreamController

ReadableByteStreamController

class ReadableByteStreamController : ReadableStreamController<Void> (source)

The ReadableByteStreamController interface of the Streams API represents a controller for a readable byte stream.

MDN Reference

Properties

Link copied to clipboard
val byobRequest: ReadableStreamBYOBRequest?

The byobRequest read-only property of the ReadableByteStreamController interface returns the current BYOB request, or null if there are no pending requests.

Link copied to clipboard
val desiredSize: Double?

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

Functions

Link copied to clipboard
fun close()

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

Link copied to clipboard
fun enqueue(chunk: ArrayBufferView<ArrayBuffer>)

The enqueue() method of the ReadableByteStreamController interface enqueues a given chunk on the associated readable byte stream (the chunk is copied into the stream's internal queues).

Link copied to clipboard
fun error(error: JsError = definedExternally)

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