Skip to main content
Skip to main content

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​

MDN Reference

Parameters​

reasonany

Returns​

PromisePromise<void>Required

getReader​

getReader(options): ReadableStreamBYOBReader

MDN Reference

Parameters​

optionsobjectRequired
options.mode"byob"Required

Returns​

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

getReader(): ReadableStreamDefaultReader<R>

Returns​

ReadableStreamDefaultReaderReadableStreamDefaultReader<R>Required

getReader(options?): ReadableStreamReader<R>

Parameters​

Returns​

ReadableStreamReaderReadableStreamReader<R>Required

pipeThrough​

MDN Reference

Parameters​

transformReadableWritablePair<T, R>Required
optionsStreamPipeOptions

Returns​

ReadableStreamReadableStream<T>Required

pipeTo​

MDN Reference

Parameters​

destinationWritableStream<R>Required
optionsStreamPipeOptions

Returns​

PromisePromise<void>Required

tee​

MDN Reference

Returns​

[[`ReadableStream`](/references/js-client/modules/internal#readablestream)<`R`\>, [`ReadableStream`](/references/js-client/modules/internal#readablestream)<`R`\>][ReadableStream<R>, ReadableStream<R>]Required
Was this section helpful?
© 2023 Medusa, Inc. All rights reserved.