class ReadableStream | globals module | Bun

class ReadableStream | globals module | BunBuildDocsReferenceGuidesBlogDiscord/Globals/ReadableStreamM[Symbol.asyncIterator]McancelMgetReaderPlockedMpipeThroughMpipeToMteeMvalues

Search the reference...

/

BuildDocsReferenceGuidesBlogDiscord/Globals/ReadableStreamM[Symbol.asyncIterator]McancelMgetReaderPlockedMpipeThroughMpipeToMteeMvalues

class

ReadableStreamclass ReadableStreamR = any>

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

readonly locked: boolean

MDN Reference

[Symbol.asyncIterator](options?: ReadableStreamIteratorOptions): ReadableStreamAsyncIteratorR>;cancel(reason?: any): Promisevoid>;

MDN Reference

getReader(options: { mode: 'byob' }): ReadableStreamBYOBReader;

MDN Reference

getReader(): ReadableStreamDefaultReaderR>;getReader(options?: ReadableStreamGetReaderOptions): ReadableStreamReaderR>;pipeThroughT>(transform: ReadableWritablePairT, R>,options?: StreamPipeOptions): ReadableStreamT>;

MDN Reference

pipeTo(destination: WritableStreamR>,options?: StreamPipeOptions): Promisevoid>;

MDN Reference

tee(): [ReadableStreamR>, ReadableStreamR>];

MDN Reference

values(options?: ReadableStreamIteratorOptions): ReadableStreamAsyncIteratorR>;

Resources

ReferenceDocsGuidesDiscordMerch StoreGitHubBlog 

Toolkit

RuntimePackage managerTest runnerBundlerPackage runner

Project

Bun 1.0Bun 1.1Bun 1.2Bun 1.3RoadmapContributingLicense

Baked with ❤️ in San Francisco

We're hiring →