ReadableStream
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 = any> {
readonly locked: boolean;
[[Symbol.asyncIterator]](options?: {
preventCancel?: boolean;
}): AsyncIterableIterator<R>;cancel(reason?: any): Promise<void>;
getReader(options: {
mode: "byob";
}): ReadableStreamBYOBReader;getReader(options?: {
mode?: undefined;
}): ReadableStreamDefaultReader<R>;pipeThrough<T>(transform: {
writable: WritableStream<R>;
readable: ReadableStream<T>;
}, options?: PipeOptions): ReadableStream<T>;tee(): [ReadableStream<R>, ReadableStream<R>];
values(options?: {
}preventCancel?: boolean;
}): AsyncIterableIterator<R>;var ReadableStream: {
readonly prototype: ReadableStream;
new (underlyingSource: UnderlyingByteSource, strategy?: {
highWaterMark?: number;
size?: undefined;
}): ReadableStream<Uint8Array>; new <R = any>(underlyingSource?: UnderlyingSource<R>, strategy?: QueuingStrategy<R>): ReadableStream<R>;
from<R>(asyncIterable: AsyncIterable<R> | Iterable<R | PromiseLike<R>>): ReadableStream<R>;
};§Methods
§
getReader(options: {
[src]mode: "byob";
}): ReadableStreamBYOBReader§
getReader(options?: {
[src]mode?: undefined;
}): ReadableStreamDefaultReader<R>§
pipeThrough<T>(transform: {
[src]writable: WritableStream<R>;
readable: ReadableStream<T>;
}, options?: PipeOptions): ReadableStream<T>§
tee(): [ReadableStream<R>, ReadableStream<R>]
[src]