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 external class ReadableStreamBYOBReader(stream: ReadableStream<Uint8Array<*>>) : ReadableStreamGenericReader

MDN Reference

ReadableStreamBYOBRequest

external class ReadableStreamBYOBRequest

MDN Reference

ReadableStreamController

sealed external interface ReadableStreamController<T>

Union of:

ReadableStreamDefaultController

external class ReadableStreamDefaultController<R> : ReadableStreamController<R>

MDN Reference

ReadableStreamDefaultReader

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

MDN Reference

ReadableStreamGenericReader

sealed external interface ReadableStreamGenericReader

ReadableStreamGetReaderOptions

external interface ReadableStreamGetReaderOptions

ReadableStreamIteratorOptions

external interface ReadableStreamIteratorOptions

ReadableStreamReadDoneResult

external class ReadableStreamReadDoneResult<T> : ReadableStreamReadResult<T>

ReadableStreamReader

typealias ReadableStreamReader = ReadableStreamGenericReader

ReadableStreamReaderMode

sealed external interface ReadableStreamReaderMode

ReadableStreamReadResult

sealed external interface ReadableStreamReadResult<T>

Union of:

ReadableStreamReadValueResult

external class ReadableStreamReadValueResult<T> : ReadableStreamReadResult<T>

ReadableStreamType

sealed external interface ReadableStreamType

ReadableWritablePair

external interface ReadableWritablePair<R, W>

StreamPipeOptions

external interface StreamPipeOptions : Abortable

Transformer

external interface Transformer<I, O>

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 external class TransformStream<I, O>(transformer: Transformer<I, O> = definedExternally, writableStrategy: QueuingStrategy<I> = definedExternally, readableStrategy: QueuingStrategy<O> = definedExternally) : Transferable

MDN Reference

TransformStreamDefaultController

external class TransformStreamDefaultController<O>

MDN Reference

UnderlyingByteSource

sealed external interface UnderlyingByteSource

UnderlyingDefaultSource

sealed external interface UnderlyingDefaultSource<R>

UnderlyingSink

external interface UnderlyingSink<W>

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

external interface UnderlyingSource<R>

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 external class WritableStream<W>(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

external 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 external class WritableStreamDefaultWriter<W>(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.