ReadableStream
Defined in: node_modules/.pnpm/@types+node@24.6.2/node_modules/@types/node/stream/web.d.ts:178
This Streams API interface represents a readable stream of byte data.
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
R | any |
Properties
Section titled “Properties”locked
Section titled “locked”readonly locked: boolean;Defined in: node_modules/.pnpm/@types+node@24.6.2/node_modules/@types/node/stream/web.d.ts:179
Methods
Section titled “Methods”[asyncIterator]()
Section titled “[asyncIterator]()”asyncIterator: ReadableStreamAsyncIterator<R>;Defined in: node_modules/.pnpm/@types+node@24.6.2/node_modules/@types/node/stream/web.d.ts:188
Returns
Section titled “Returns”ReadableStreamAsyncIterator<R>
cancel()
Section titled “cancel()”cancel(reason?): Promise<void>;Defined in: node_modules/.pnpm/@types+node@24.6.2/node_modules/@types/node/stream/web.d.ts:180
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
reason? | any |
Returns
Section titled “Returns”Promise<void>
getReader()
Section titled “getReader()”Call Signature
Section titled “Call Signature”getReader(options): ReadableStreamBYOBReader;Defined in: node_modules/.pnpm/@types+node@24.6.2/node_modules/@types/node/stream/web.d.ts:181
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options | { mode: "byob"; } |
options.mode | "byob" |
Returns
Section titled “Returns”Call Signature
Section titled “Call Signature”getReader(): ReadableStreamDefaultReader<R>;Defined in: node_modules/.pnpm/@types+node@24.6.2/node_modules/@types/node/stream/web.d.ts:182
Returns
Section titled “Returns”ReadableStreamDefaultReader<R>
Call Signature
Section titled “Call Signature”getReader(options?): ReadableStreamReader<R>;Defined in: node_modules/.pnpm/@types+node@24.6.2/node_modules/@types/node/stream/web.d.ts:183
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options? | ReadableStreamGetReaderOptions |
Returns
Section titled “Returns”pipeThrough()
Section titled “pipeThrough()”pipeThrough<T>(transform, options?): ReadableStream<T>;Defined in: node_modules/.pnpm/@types+node@24.6.2/node_modules/@types/node/stream/web.d.ts:184
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
T |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
transform | ReadableWritablePair<T, R> |
options? | StreamPipeOptions |
Returns
Section titled “Returns”ReadableStream<T>
pipeTo()
Section titled “pipeTo()”pipeTo(destination, options?): Promise<void>;Defined in: node_modules/.pnpm/@types+node@24.6.2/node_modules/@types/node/stream/web.d.ts:185
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
destination | WritableStream<R> |
options? | StreamPipeOptions |
Returns
Section titled “Returns”Promise<void>
tee(): [ReadableStream<R>, ReadableStream<R>];Defined in: node_modules/.pnpm/@types+node@24.6.2/node_modules/@types/node/stream/web.d.ts:186
Returns
Section titled “Returns”[ReadableStream<R>, ReadableStream<R>]
values()
Section titled “values()”values(options?): ReadableStreamAsyncIterator<R>;Defined in: node_modules/.pnpm/@types+node@24.6.2/node_modules/@types/node/stream/web.d.ts:187
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options? | { preventCancel?: boolean; } |
options.preventCancel? | boolean |