ReadableStreamBYOBReader

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2284

Constructors

Constructor

new ReadableStreamBYOBReader(stream): ReadableStreamBYOBReader

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2285

Parameters

stream

ReadableStream

Returns

ReadableStreamBYOBReader

Properties

closed

readonly closed: Promise<void>

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2286

Methods

cancel()

cancel(reason?): Promise<void>

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2287

Parameters

reason?

any

Returns

Promise<void>

---

read()

read<T>(view): Promise<ReadableStreamReadResult<T>>

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2289

Type Parameters

T

T extends ArrayBufferView<ArrayBufferLike>

Parameters

view

T

Returns

Promise<ReadableStreamReadResult<T>>

---

readAtLeast()

readAtLeast<T>(minElements, view): Promise<ReadableStreamReadResult<T>>

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2294

Type Parameters

T

T extends ArrayBufferView<ArrayBufferLike>

Parameters

minElements

number

view

T

Returns

Promise<ReadableStreamReadResult<T>>

---

releaseLock()

releaseLock(): void

Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20250823.0/node_modules/@cloudflare/workers-types/index.ts:2293

Returns

void