Documentation
    Preparing search index...

    Interface ControllableReadableStream<T>

    An interface for a ControllableStream:class.

    interface ControllableReadableStream<T> {
        desiredSize: number | null;
        locked: boolean;
        "[asyncIterator]"(
            options?: ReadableStreamIteratorOptions,
        ): ReadableStreamAsyncIterator<T>;
        cancel(reason?: any): Promise<void>;
        close(): void;
        enqueue(chunk: T): void;
        error(e?: any): void;
        getReader(options: { mode: "byob" }): ReadableStreamBYOBReader;
        getReader(): ReadableStreamDefaultReader<T>;
        getReader(
            options?: ReadableStreamGetReaderOptions,
        ): ReadableStreamReader<T>;
        onPull(pullListener: ControllerPullListener<T>): () => void;
        pipeThrough<T>(
            transform: ReadableWritablePair<T, T>,
            options?: StreamPipeOptions,
        ): ReadableStream<T>;
        pipeTo(
            destination: WritableStream<T>,
            options?: StreamPipeOptions,
        ): Promise<void>;
        tee(): [ReadableStream<T>, ReadableStream<T>];
        values(
            options?: ReadableStreamIteratorOptions,
        ): ReadableStreamAsyncIterator<T>;
    }

    Type Parameters

    • T

    Hierarchy (View Summary)

    Index

    Properties

    desiredSize locked

    Methods

    [asyncIterator] cancel close enqueue error getReader onPull pipeThrough pipeTo tee values

    Properties

    desiredSize: number | null
    locked: boolean

    Methods

    • Parameters

      • Optionaloptions: ReadableStreamIteratorOptions

      Returns ReadableStreamAsyncIterator<T>

    • Parameters

      • Optionalreason: any

      Returns Promise<void>

    • Returns void

    • Parameters

      • chunk: T

      Returns void

    • Parameters

      • Optionale: any

      Returns void

    • Parameters

      • options: { mode: "byob" }

      Returns ReadableStreamBYOBReader

    • Returns ReadableStreamDefaultReader<T>

    • Parameters

      • Optionaloptions: ReadableStreamGetReaderOptions

      Returns ReadableStreamReader<T>

    • Type Parameters

      • T

      Parameters

      • transform: ReadableWritablePair<T, T>
      • Optionaloptions: StreamPipeOptions

      Returns ReadableStream<T>

    • Parameters

      • destination: WritableStream<T>
      • Optionaloptions: StreamPipeOptions

      Returns Promise<void>

    • Returns [ReadableStream<T>, ReadableStream<T>]

    • Parameters

      • Optionaloptions: ReadableStreamIteratorOptions

      Returns ReadableStreamAsyncIterator<T>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods