Interface ReadableStream<R>

interface ReadableStream<R> {
    locked: boolean;
    [asyncIterator](options?: ReadableStreamIteratorOptions): ReadableStreamAsyncIterator<R>;
    cancel(reason?: any): Promise<void>;
    getReader(options: {
        mode: "byob";
    }): ReadableStreamBYOBReader;
    getReader(): ReadableStreamDefaultReader<R>;
    getReader(options?: ReadableStreamGetReaderOptions): ReadableStreamReader<R>;
    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?: ReadableStreamIteratorOptions): ReadableStreamAsyncIterator<R>;
}

Type Parameters

R = any

Index

Properties

Methods

[asyncIterator] cancel getReader pipeThrough pipeTo tee values

Properties

`Readonly`locked

locked: boolean

Methods

[asyncIterator]

[asyncIterator](options?): ReadableStreamAsyncIterator<R>
Parameters
- Optionaloptions: ReadableStreamIteratorOptions
Returns ReadableStreamAsyncIterator<R>

cancel

cancel(reason?): Promise<void>
MDN Reference
Parameters
- Optionalreason: any
Returns Promise<void>

getReader

getReader(options): ReadableStreamBYOBReader
MDN Reference
Parameters
- options: {
  mode: "byob";
  }
  - mode: "byob"
Returns ReadableStreamBYOBReader
getReader(): ReadableStreamDefaultReader<R>
Returns ReadableStreamDefaultReader<R>
getReader(options?): ReadableStreamReader<R>
Parameters
- Optionaloptions: ReadableStreamGetReaderOptions
Returns ReadableStreamReader<R>

pipeThrough

pipeThrough<T>(transform, options?): ReadableStream<T>
MDN Reference
Type Parameters
- T
Parameters
- transform: ReadableWritablePair<T, R>
- Optionaloptions: StreamPipeOptions
Returns ReadableStream<T>

pipeTo

pipeTo(destination, options?): Promise<void>
MDN Reference
Parameters
- destination: WritableStream<R>
- Optionaloptions: StreamPipeOptions
Returns Promise<void>

tee

tee(): [ReadableStream<R>, ReadableStream<R>]
MDN Reference

Returns [ReadableStream<R>, ReadableStream<R>]

values

values(options?): ReadableStreamAsyncIterator<R>
Parameters
- Optionaloptions: ReadableStreamIteratorOptions
Returns ReadableStreamAsyncIterator<R>