Interface ReadableStream<R>

This Streams API interface represents a readable stream of byte data. The Fetch API offers a concrete instance of a ReadableStream through the body property of a Response object.

interface ReadableStream<R> {
    locked: boolean;
    [asyncIterator](options?): AsyncIterableIterator<R>;
    cancel(reason?): Promise<void>;
    getReader(): ReadableStreamDefaultReader<R>;
    getReader(options): ReadableStreamBYOBReader;
    pipeThrough<T>(transform, options?): ReadableStream<T>;
    pipeTo(destination, options?): Promise<void>;
    tee(): [ReadableStream<R>, ReadableStream<R>];
    values(options?): AsyncIterableIterator<R>;
}

Type Parameters

R = any

Index

Properties

Methods

[asyncIterator] cancel getReader pipeThrough pipeTo tee values

Properties

`Readonly` locked

locked: boolean

Methods

[asyncIterator]

[asyncIterator](options?): AsyncIterableIterator<R>
Parameters
- Optional options: ReadableStreamValuesOptions
Returns AsyncIterableIterator<R>
- Defined in index.ts:1908

cancel

cancel(reason?): Promise<void>
MDN Reference
Parameters
- Optional reason: any
Returns Promise<void>
- Defined in index.ts:1890

getReader

getReader(): ReadableStreamDefaultReader<R>
MDN Reference

Returns ReadableStreamDefaultReader<R>
- Defined in index.ts:1892
getReader(options): ReadableStreamBYOBReader
MDN Reference
Parameters
- options: ReadableStreamGetReaderOptions
Returns ReadableStreamBYOBReader
- Defined in index.ts:1894

pipeThrough

pipeThrough<T>(transform, options?): ReadableStream<T>
MDN Reference
Type Parameters
- T
Parameters
- transform: ReadableWritablePair<T, R>
- Optional options: StreamPipeOptions
Returns ReadableStream<T>
- Defined in index.ts:1896

pipeTo

pipeTo(destination, options?): Promise<void>
MDN Reference
Parameters
- destination: WritableStream<R>
- Optional options: StreamPipeOptions
Returns Promise<void>
- Defined in index.ts:1901

tee

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

Returns [ReadableStream<R>, ReadableStream<R>]
- Defined in index.ts:1906

values

values(options?): AsyncIterableIterator<R>
Parameters
- Optional options: ReadableStreamValuesOptions
Returns AsyncIterableIterator<R>
- Defined in index.ts:1907