@shazow/whatsabi
    Preparing search index...

    Interface ReadableStreamBYOBReader

    The ReadableStreamBYOBReader interface of the Streams API defines a reader for a ReadableStream that supports zero-copy reading from an underlying byte source. It is used for efficient copying from underlying sources where the data is delivered as an "anonymous" sequence of bytes, such as files.

    MDN Reference

    interface ReadableStreamBYOBReader {
        closed: Promise<void>;
        cancel(reason?: any): Promise<void>;
        read<T extends ArrayBufferView<ArrayBuffer>>(
            view: T,
            options?: ReadableStreamBYOBReaderReadOptions,
        ): Promise<ReadableStreamReadResult<T>>;
        releaseLock(): void;
    }

    Hierarchy (View Summary)

    Index
    • Parameters

      • Optionalreason: any

      Returns Promise<void>

    • The releaseLock() method of the ReadableStreamBYOBReader interface releases the reader's lock on the stream. After the lock is released, the reader is no longer active.

      MDN Reference

      Returns void

    closed: Promise<void>