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.

Type parameters

R = any

Hierarchy

ReadableStream

Index

Properties

locked

Methods

Properties

Readonly locked

locked: boolean

Methods

cancel

cancel(reason?: any): Promise<void>

- Defined in node_modules/.pnpm/typescript@4.6.3/node_modules/typescript/lib/lib.dom.d.ts:11129
Parameters
- Optional reason: any
Returns Promise<void>

getReader

getReader(): <internal>.ReadableStreamDefaultReader<R>

- Defined in node_modules/.pnpm/typescript@4.6.3/node_modules/typescript/lib/lib.dom.d.ts:11130
Returns <internal>.ReadableStreamDefaultReader<R>

pipeThrough

pipeThrough<T>(transform: ReadableWritablePair<T, R>, options?: StreamPipeOptions): <internal>.ReadableStream<T>

- Defined in node_modules/.pnpm/typescript@4.6.3/node_modules/typescript/lib/lib.dom.d.ts:11131
Type parameters
- T
Parameters
- transform: ReadableWritablePair<T, R>
- Optional options: StreamPipeOptions
Returns <internal>.ReadableStream<T>

pipeTo

pipeTo(destination: <internal>.WritableStream<R>, options?: StreamPipeOptions): Promise<void>

- Defined in node_modules/.pnpm/typescript@4.6.3/node_modules/typescript/lib/lib.dom.d.ts:11132
Parameters
- destination: <internal>.WritableStream<R>
- Optional options: StreamPipeOptions
Returns Promise<void>

tee

tee(): [<internal>.ReadableStream<R>, <internal>.ReadableStream<R>]

- Defined in node_modules/.pnpm/typescript@4.6.3/node_modules/typescript/lib/lib.dom.d.ts:11133
Returns [<internal>.ReadableStream<R>, <internal>.ReadableStream<R>]

Generated using TypeDoc