kotlin-web/web.streams/ReadableStream

ReadableStream

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

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

MDN Reference

Constructors

ReadableStream

constructor(underlyingSource: UnderlyingByteSource, strategy: QueuingStrategy<R> = definedExternally)

constructor(underlyingSource: UnderlyingDefaultSource<R>, strategy: QueuingStrategy<R> = definedExternally)

constructor(underlyingSource: UnderlyingSource<R> = definedExternally, strategy: QueuingStrategy<R> = definedExternally)

Properties

locked

val locked: Boolean

The locked read-only property of the ReadableStream interface returns whether or not the readable stream is locked to a reader.

Functions

cancel

inline suspend fun <R : JsAny?> ReadableStream<R>.cancel()

inline suspend fun <R : JsAny?> ReadableStream<R>.cancel(reason: JsError?)

The cancel() method of the ReadableStream interface returns a Promise that resolves when the stream is canceled.

cancelAsync

fun cancelAsync(reason: JsError? = definedExternally): Promise<Void?>

The cancel() method of the ReadableStream interface returns a Promise that resolves when the stream is canceled.

get

open operator fun get(key: Symbol.asyncIterator): () -> AsyncIterator<R>

getReader

fun getReader(): ReadableStreamDefaultReader<R>

The getReader() method of the ReadableStream interface creates a reader and locks the stream to it. While the stream is locked, no other reader can be acquired until this one is released.

fun getReader(options: ReadableStreamGetReaderOptions = definedExternally): ReadableStreamReader

pipeThrough

fun <T : JsAny?> pipeThrough(transform: ReadableWritablePair<T, R>, options: StreamPipeOptions = definedExternally): ReadableStream<T>

The pipeThrough() method of the ReadableStream interface provides a chainable way of piping the current stream through a transform stream or any other writable/readable pair.

pipeTo

suspend fun <R : JsAny?> ReadableStream<R>.pipeTo(destination: WritableStream<R>)

suspend fun <R : JsAny?> ReadableStream<R>.pipeTo(destination: WritableStream<R>, options: StreamPipeOptions)

The pipeTo() method of the ReadableStream interface pipes the current ReadableStream to a given WritableStream and returns a Promise that fulfills when the piping process completes successfully, or rejects if any errors were encountered.

pipeToAsync

fun pipeToAsync(destination: WritableStream<R>, options: StreamPipeOptions = definedExternally): Promise<Void?>

tee

fun tee(): Tuple2<ReadableStream<R>, ReadableStream<R>>

The tee() method of the ReadableStream interface tees the current readable stream, returning a two-element array containing the two resulting branches as new ReadableStream instances.

values

fun values(options: ReadableStreamIteratorOptions = definedExternally): AsyncIterator<R>