ReadableStream

admin/uploads.internal.ReadableStream

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.

MDN Reference

Type parameters

RobjectRequired

Properties

lockedbooleanRequired

MDN Reference

Methods

cancel

cancel(reason?): Promise<void>

MDN Reference

Parameters

reasonany

Returns

Promise<void>

PromisePromise<void>Required

---

getReader

getReader(options): ReadableStreamBYOBReader

MDN Reference

Parameters

optionsobjectRequired

options.mode"byob"Required

Returns

ReadableStreamBYOBReader

ReadableStreamBYOBReader(stream: ReadableStream<any>) => ReadableStreamBYOBReaderRequired

getReader(): ReadableStreamDefaultReader<R>

Returns

ReadableStreamDefaultReader<R>

ReadableStreamDefaultReaderReadableStreamDefaultReader<R>Required

getReader(options?): ReadableStreamReader<R>

Parameters

optionsReadableStreamGetReaderOptions

Returns

ReadableStreamReader<R>

ReadableStreamReaderReadableStreamReader<R>Required

---

pipeThrough

pipeThrough<T>(transform, options?): ReadableStream<T>

MDN Reference

TobjectRequired

Parameters

transformReadableWritablePair<T, R>Required

optionsStreamPipeOptions

Returns

ReadableStream<T>

ReadableStreamReadableStream<T>Required

---

pipeTo

pipeTo(destination, options?): Promise<void>

MDN Reference

Parameters

destinationWritableStream<R>Required

optionsStreamPipeOptions

Returns

Promise<void>

PromisePromise<void>Required

---

tee

tee(): [ReadableStream<R>, ReadableStream<R>]

MDN Reference

Returns

[ReadableStream<R>, ReadableStream<R>]

[[`ReadableStream`](/references/js-client/admin_uploads/modules/admin_uploads.internal#readablestream)<`R`\>, [`ReadableStream`](/references/js-client/admin_uploads/modules/admin_uploads.internal#readablestream)<`R`\>][ReadableStream<R>, ReadableStream<R>]Required