Interface ReadableStreamBYOBReader

interface ReadableStreamBYOBReader {
    closed: Promise<undefined>;
    cancel(reason?): Promise<void>;
    read<T>(view, options?): Promise<ReadableStreamReadResult<T>>;
    releaseLock(): void;
}

Hierarchy

ReadableStreamGenericReader
- ReadableStreamBYOBReader

Index

Methods

cancel read releaseLock

Properties

Methods

cancel

cancel(reason?): Promise<void>
Parameters
- Optional reason: any
Returns Promise<void>
Inherited from ReadableStreamGenericReader.cancel

read

read<T>(view, options?): Promise<ReadableStreamReadResult<T>>
MDN Reference
Type Parameters
- T extends ArrayBufferView
Parameters
- view: T
- Optional options: {
  min?: number;
  }
  - Optional min?: number
Returns Promise<ReadableStreamReadResult<T>>

releaseLock

releaseLock(): void
MDN Reference

Returns void

Properties

`Readonly` closed

closed: Promise<undefined>