ReadableStream

This Streams API interface represents a readable stream of byte data.

Type parameters

RobjectRequired

Properties

lockedbooleanRequired

Methods

[asyncIterator]

Returns

AsyncIterableIteratorAsyncIterableIterator<R>Required

---

cancel

Parameters

reasonany

Returns

PromisePromise<void>Required

---

getReader

**getReader**(): [ReadableStreamDefaultReader](/references/js-client/modules/internal#readablestreamdefaultreader-1)<R>

Returns

ReadableStreamDefaultReaderReadableStreamDefaultReader<R>Required

**getReader**(options): [ReadableStreamBYOBReader](/references/js-client/modules/internal#readablestreambyobreader-1)

Parameters

optionsobjectRequired

options.mode"byob"Required

Returns

ReadableStreamBYOBReaderanyRequired

---

pipeThrough

Parameters

transformReadableWritablePair<T, R>Required

optionsStreamPipeOptions

Returns

ReadableStreamReadableStream<T>Required

---

pipeTo

Parameters

destinationWritableStream<R>Required

optionsStreamPipeOptions

Returns

PromisePromise<void>Required

---

tee

Returns

[ReadableStream<R>, ReadableStream<R>][ReadableStream<R>, ReadableStream<R>]Required

---

values

Parameters

optionsobject

options.preventCancelboolean

Returns

AsyncIterableIteratorAsyncIterableIterator<R>Required