Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

x/deno/ext/web/lib.deno_web.d.ts>ReadableStream

A modern runtime for JavaScript and TypeScript.
Go to Latest
interface ReadableStream
import { type ReadableStream } from "https://deno.land/x/deno@v1.38.1/ext/web/lib.deno_web.d.ts";

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.

Type Parameters

optional
R = any

Properties

readonly
locked: boolean

Methods

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>
pipeTo(dest: WritableStream<R>, options?: PipeOptions): Promise<void>
values(options?: { preventCancel?: boolean; }): AsyncIterableIterator<R>
[[Symbol.asyncIterator]](options?: { preventCancel?: boolean; }): AsyncIterableIterator<R>
variable ReadableStream
import { ReadableStream } from "https://deno.land/x/deno@v1.38.1/ext/web/lib.deno_web.d.ts";

type

{ 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>; }