This Streams API interface represents a readable stream of byte data. The Fetch API offers a concrete instance of a ReadableStream through the body property of a Response object.

ReadableStreamBYOBReader

open class ReadableStreamBYOBReader(stream: ReadableStream<Uint8Array<*>>) : ReadableStreamGenericReader

MDN Reference

ReadableStreamBYOBRequest

class ReadableStreamBYOBRequest

MDN Reference

ReadableStreamController

sealed interface ReadableStreamController<T : JsAny?>

Union of:

ReadableStreamDefaultController

class ReadableStreamDefaultController<R : JsAny?> : ReadableStreamController<R>

MDN Reference

ReadableStreamDefaultReader

open class ReadableStreamDefaultReader<R : JsAny?>(stream: ReadableStream<R>) : ReadableStreamGenericReader

MDN Reference

ReadableStreamGenericReader

sealed interface ReadableStreamGenericReader

ReadableStreamGetReaderOptions

interface ReadableStreamGetReaderOptions

ReadableStreamIteratorOptions

interface ReadableStreamIteratorOptions

ReadableStreamReadDoneResult

class ReadableStreamReadDoneResult<T : JsAny?> : ReadableStreamReadResult<T>

ReadableStreamReader

typealias ReadableStreamReader = ReadableStreamGenericReader

ReadableStreamReaderMode

sealed interface ReadableStreamReaderMode

ReadableStreamReadResult

sealed interface ReadableStreamReadResult<T : JsAny?>

Union of:

ReadableStreamReadValueResult

class ReadableStreamReadValueResult<T : JsAny?> : ReadableStreamReadResult<T>

ReadableStreamType

sealed interface ReadableStreamType

ReadableWritablePair

interface ReadableWritablePair<R : JsAny?, W : JsAny?>

StreamPipeOptions

interface StreamPipeOptions : Abortable

Transformer

interface Transformer<I : JsAny?, O : JsAny?>

TransformerFlushCallback

typealias TransformerFlushCallback<O> = (controller: TransformStreamDefaultController<O>) -> PromiseLike<Void>?

TransformerStartCallback

typealias TransformerStartCallback<O> = (controller: TransformStreamDefaultController<O>) -> Unit

TransformerTransformCallback

typealias TransformerTransformCallback<I, O> = (chunk: I, controller: TransformStreamDefaultController<O>) -> PromiseLike<Void>?

TransformStream

open class TransformStream<I : JsAny?, O : JsAny?>( transformer: Transformer<I, O> = definedExternally, writableStrategy: QueuingStrategy<I> = definedExternally, readableStrategy: QueuingStrategy<O> = definedExternally) : Transferable

MDN Reference

TransformStreamDefaultController

class TransformStreamDefaultController<O : JsAny?>

MDN Reference

UnderlyingByteSource

sealed interface UnderlyingByteSource

UnderlyingDefaultSource

sealed interface UnderlyingDefaultSource<R : JsAny?>

UnderlyingSink

interface UnderlyingSink<W : JsAny?>

UnderlyingSinkAbortCallback

typealias UnderlyingSinkAbortCallback = (reason: JsError?) -> PromiseLike<Void>?

UnderlyingSinkCloseCallback

typealias UnderlyingSinkCloseCallback = () -> PromiseLike<Void>?

UnderlyingSinkStartCallback

typealias UnderlyingSinkStartCallback = (controller: WritableStreamDefaultController) -> Unit

UnderlyingSinkWriteCallback

typealias UnderlyingSinkWriteCallback<W> = (chunk: W, controller: WritableStreamDefaultController) -> PromiseLike<Void>?

UnderlyingSource

interface UnderlyingSource<R : JsAny?>

UnderlyingSourceCancelCallback

typealias UnderlyingSourceCancelCallback = (reason: JsError?) -> PromiseLike<Void>?

UnderlyingSourcePullCallback

typealias UnderlyingSourcePullCallback<R> = (controller: ReadableStreamController<R>) -> PromiseLike<Void>?

UnderlyingSourceStartCallback

typealias UnderlyingSourceStartCallback<R> = (controller: ReadableStreamController<R>) -> Unit

WritableStream

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

This Streams API interface provides a standard abstraction for writing streaming data to a destination, known as a sink. This object comes with built-in backpressure and queuing.

WritableStreamDefaultController

class WritableStreamDefaultController

This Streams API interface represents a controller allowing control of a WritableStream's state. When constructing a WritableStream, the underlying sink is given a corresponding WritableStreamDefaultController instance to manipulate.

WritableStreamDefaultWriter

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

This Streams API interface 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.