@shazow/whatsabi
    Preparing search index...

    Interface ReadableStreamDefaultController<R>

    The ReadableStreamDefaultController interface of the Streams API represents a controller allowing control of a ReadableStream's state and internal queue. Default controllers are for streams that are not byte streams.

    MDN Reference

    interface ReadableStreamDefaultController<R = any> {
        desiredSize: number | null;
        close(): void;
        enqueue(chunk: R): void;
        error(e?: any): void;
    }

    Type Parameters

    • R = any
    Index
    close enqueue error
    desiredSize

    • The close() method of the ReadableStreamDefaultController interface closes the associated stream.

      MDN Reference

      Returns void

    • The enqueue() method of the ReadableStreamDefaultController interface enqueues a given chunk in the associated stream.

      MDN Reference

      Parameters

      • chunk: R

      Returns void

    • The error() method of the ReadableStreamDefaultController interface causes any future interactions with the associated stream to error.

      MDN Reference

      Parameters

      • Optionale: any

      Returns void

    desiredSize: number | null

    The desiredSize read-only property of the ReadableStreamDefaultController interface returns the desired size required to fill the stream's internal queue.

    MDN Reference

    Settings
    Member Visibility

    On This Page
    Methods
    Properties