kotlin-web/web.streams/ReadableStreamDefaultReader

ReadableStreamDefaultReader

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

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).

MDN Reference

Constructors

constructor(stream: ReadableStream<R>)

Properties

closed

open external val closed: Promise<Void>

MDN Reference

Functions

cancel

inline suspend fun ReadableStreamGenericReader.cancel()

inline suspend fun ReadableStreamGenericReader.cancel(reason: JsError?)

MDN Reference

cancelAsync

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

MDN Reference

read

inline suspend fun <R : JsAny?> ReadableStreamDefaultReader<R>.read(): ReadableStreamReadResult<R>

The read() method of the ReadableStreamDefaultReader interface returns a Promise providing access to the next chunk in the stream's internal queue.

readAsync

external fun readAsync(): Promise<ReadableStreamReadResult<R>>

The read() method of the ReadableStreamDefaultReader interface returns a Promise providing access to the next chunk in the stream's internal queue.

releaseLock

external fun releaseLock()

The releaseLock() method of the ReadableStreamDefaultReader interface releases the reader's lock on the stream.