kotlin-web/web.streams/ReadableStream

ReadableStream

open external class ReadableStream<R>(underlyingSource: UnderlyingDefaultSource<R>, strategy: QueuingStrategy<R> = definedExternally) : Transferable(source)

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.

MDN Reference

Constructors

ReadableStream

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

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

Properties

locked

val locked: Boolean

MDN Reference

Functions

cancel

suspend fun cancel(reason: JsError? = definedExternally)

MDN Reference

cancelAsync

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

getReader

fun getReader(): ReadableStreamDefaultReader<R>

MDN Reference

fun getReader(options: ReadableStreamGetReaderOptions = definedExternally): ReadableStreamReader

pipeThrough

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

MDN Reference

pipeTo

suspend fun pipeTo(destination: WritableStream<R>, options: StreamPipeOptions = definedExternally)

MDN Reference

pipeToAsync

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

tee

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

MDN Reference