trakteerjs
    Preparing search index...

    Interface ReadableStream<R>

    This Streams API interface represents a readable stream of byte data.

    interface ReadableStream<R = any> {
        locked: boolean;
        "[asyncIterator]"(): AsyncIterableIterator<R>;
        cancel(reason?: any): Promise<void>;
        getReader(): ReadableStreamDefaultReader<R>;
        getReader(options: { mode: "byob" }): ReadableStreamBYOBReader;
        pipeThrough<T>(
            transform: ReadableWritablePair<T, R>,
            options?: StreamPipeOptions,
        ): ReadableStream<T>;
        pipeTo(
            destination: WritableStream<R>,
            options?: StreamPipeOptions,
        ): Promise<void>;
        tee(): [ReadableStream<R>, ReadableStream<R>];
        values(options?: { preventCancel?: boolean }): AsyncIterableIterator<R>;
    }

    Type Parameters

    • R = any
    Index

    Properties

    locked

    Methods

    [asyncIterator] cancel getReader pipeThrough pipeTo tee values

    Properties

    locked: boolean

    Methods

    • Parameters

      • Optionalreason: any

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods