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

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 node_modules/typescript/lib/lib.dom.d.ts:11611

getReader

getReader(options: {
mode: "byob";
}): ReadableStreamBYOBReader
Parameters
- options: {
  mode: "byob";
  }
  - mode: "byob"
Returns ReadableStreamBYOBReader
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11612
getReader(): ReadableStreamDefaultReader<R>
Returns ReadableStreamDefaultReader<R>
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11613
getReader(options?: ReadableStreamGetReaderOptions): ReadableStreamReader<R>
Parameters
- Optional options: ReadableStreamGetReaderOptions
Returns ReadableStreamReader<R>
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11614

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 node_modules/typescript/lib/lib.dom.d.ts:11615

pipeTo

pipeTo(destination: WritableStream<R>, options?: StreamPipeOptions): Promise<void>
Parameters
- destination: WritableStream<R>
- Optional options: StreamPipeOptions
Returns Promise<void>
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11616

tee

tee(): [ReadableStream<R>, ReadableStream<R>]
Returns [ReadableStream<R>, ReadableStream<R>]
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11617

Interface ReadableStream<R>

Type Parameters

R = any

Hierarchy

Index

Properties

Methods

Properties

`Readonly` locked

Methods

cancel

Parameters

`Optional` reason: any

Returns Promise<void>

getReader

Parameters

options: {
mode: "byob";
}

mode: "byob"

Returns ReadableStreamBYOBReader

Returns ReadableStreamDefaultReader<R>

Parameters

`Optional` options: ReadableStreamGetReaderOptions

Returns ReadableStreamReader<R>

pipeThrough

Type Parameters

T

Parameters

transform: ReadableWritablePair<T, R>

`Optional` options: StreamPipeOptions

Returns ReadableStream<T>

pipeTo

Parameters

destination: WritableStream<R>

`Optional` options: StreamPipeOptions

Returns Promise<void>

tee

Returns [ReadableStream<R>, ReadableStream<R>]

Settings

Member Visibility

Theme

Interface ReadableStream<R>

Type Parameters

R = any

Hierarchy

Index

Properties

Methods

Properties

Readonly locked

Methods

cancel

Parameters

Optional reason: any

Returns Promise<void>

getReader

Parameters

options: { mode: "byob"; }

mode: "byob"

Returns ReadableStreamBYOBReader

Returns ReadableStreamDefaultReader<R>

Parameters

Optional options: ReadableStreamGetReaderOptions

Returns ReadableStreamReader<R>

pipeThrough

Type Parameters

T

Parameters

transform: ReadableWritablePair<T, R>

Optional options: StreamPipeOptions

Returns ReadableStream<T>

pipeTo

Parameters

destination: WritableStream<R>

Optional options: StreamPipeOptions

Returns Promise<void>

tee

Returns [ReadableStream<R>, ReadableStream<R>]

Settings

Member Visibility

Theme

`Readonly` locked

`Optional` reason: any

options: {
mode: "byob";
}

`Optional` options: ReadableStreamGetReaderOptions

`Optional` options: StreamPipeOptions

`Optional` options: StreamPipeOptions