ReadableStream
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2231
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
Section titled “Type Parameters”R = any
Properties
Section titled “Properties”locked
Section titled “locked”
readonlylocked:boolean
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2233
Methods
Section titled “Methods”[asyncIterator]()
Section titled “[asyncIterator]()”[asyncIterator](
options?):AsyncIterableIterator<R>
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2253
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”AsyncIterableIterator<R>
cancel()
Section titled “cancel()”cancel(
reason?):Promise<void>
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2235
Parameters
Section titled “Parameters”reason?
Section titled “reason?”any
Returns
Section titled “Returns”Promise<void>
getReader()
Section titled “getReader()”Call Signature
Section titled “Call Signature”getReader():
ReadableStreamDefaultReader<R>
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2237
Returns
Section titled “Returns”ReadableStreamDefaultReader<R>
Call Signature
Section titled “Call Signature”getReader(
options):ReadableStreamBYOBReader
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2239
Parameters
Section titled “Parameters”options
Section titled “options”ReadableStreamGetReaderOptions
Returns
Section titled “Returns”pipeThrough()
Section titled “pipeThrough()”pipeThrough<
T>(transform,options?):ReadableStream<T>
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2241
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”transform
Section titled “transform”ReadableWritablePair<T, R>
options?
Section titled “options?”Returns
Section titled “Returns”ReadableStream<T>
pipeTo()
Section titled “pipeTo()”pipeTo(
destination,options?):Promise<void>
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2246
Parameters
Section titled “Parameters”destination
Section titled “destination”options?
Section titled “options?”Returns
Section titled “Returns”Promise<void>
tee(): [
ReadableStream<R>,ReadableStream<R>]
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2251
Returns
Section titled “Returns”[ReadableStream<R>, ReadableStream<R>]
values()
Section titled “values()”values(
options?):AsyncIterableIterator<R>
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2252
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”AsyncIterableIterator<R>