Package-level declarations

Types

open class ByteLengthQueuingStrategy(init: QueuingStrategyInit) : QueuingStrategy<ArrayBufferView<*>>

The ByteLengthQueuingStrategy interface of the Streams API provides a built-in byte length queuing strategy that can be used when constructing streams.

CountQueuingStrategy

open class CountQueuingStrategy(init: QueuingStrategyInit) : QueuingStrategy<Void>

The CountQueuingStrategy interface of the Streams API provides a built-in chunk counting queuing strategy that can be used when constructing streams.

GenericTransformStream

sealed interface GenericTransformStream

QueuingStrategy

sealed interface QueuingStrategy<T : JsAny?>

QueuingStrategyInit

interface QueuingStrategyInit

QueuingStrategySize

typealias QueuingStrategySize<T> = (chunk: T) -> Int

ReadableByteStreamController

class ReadableByteStreamController : ReadableStreamController<Void>

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

ReadableStream

open class ReadableStream<R : JsAny?>( underlyingSource: UnderlyingByteSource, strategy: QueuingStrategy<R> = definedExternally) : Transferable, AsyncIterable<R>

The ReadableStream interface of the Streams API represents a readable stream of byte data.

ReadableStreamBYOBReader

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

The ReadableStreamBYOBReader interface of the Streams API defines a reader for a ReadableStream that supports zero-copy reading from an underlying byte source.

ReadableStreamBYOBRequest

class ReadableStreamBYOBRequest

The ReadableStreamBYOBRequest interface of the Streams API represents a 'pull request' for data from an underlying source that will made as a zero-copy transfer to a consumer (bypassing the stream's internal queues).

ReadableStreamController

sealed interface ReadableStreamController<T : JsAny?>

Union of:

ReadableStreamDefaultController

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

The ReadableStreamDefaultController interface of the Streams API represents a controller allowing control of a ReadableStream's state and internal queue.

ReadableStreamDefaultReader

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

The ReadableStreamDefaultReader interface of the Streams API represents a default reader that can be used to read stream data supplied from a network (such as a fetch request).

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

The TransformStream interface of the Streams API represents a concrete implementation of the pipe chain transform stream concept.

TransformStreamDefaultController

class TransformStreamDefaultController<O : JsAny?>

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

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

The WritableStream interface of the Streams API provides a standard abstraction for writing streaming data to a destination, known as a sink.

WritableStreamDefaultController

class WritableStreamDefaultController

The WritableStreamDefaultController interface of the Streams API represents a controller allowing control of a WritableStream's state.

WritableStreamDefaultWriter

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

The WritableStreamDefaultWriter interface of the Streams API 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.