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

Methods

cancel getReader pipeThrough pipeTo tee

Properties

`Readonly` locked

locked: boolean

Methods

cancel

cancel(reason?: any): Promise<void>
Parameters
- Optional reason: any
Returns Promise<void>
- Defined in globals.d.ts:1296

getReader

getReader(): ReadableStreamDefaultReader<R>
Returns ReadableStreamDefaultReader<R>
- Defined in globals.d.ts:1297

pipeThrough

pipeThrough<T>(transform: ReadableWritablePair<T, R>, options?: StreamPipeOptions): ReadableStream<T>
Type Parameters
- T
Parameters
- transform: ReadableWritablePair<T, R>
- Optional options: StreamPipeOptions
Returns ReadableStream<T>
- Defined in globals.d.ts:1298

pipeTo

pipeTo(dest: WritableStream<R>, options?: StreamPipeOptions): Promise<void>
Parameters
- dest: WritableStream<R>
- Optional options: StreamPipeOptions
Returns Promise<void>
- Defined in globals.d.ts:1299

tee

tee(): [ReadableStream<R>, ReadableStream<R>]
Returns [ReadableStream<R>, ReadableStream<R>]
- Defined in globals.d.ts:1300

Generated using TypeDoc