function isReadable | Node.js stream module | Bun

function isReadable | Node.js stream module | BunBuildDocsReferenceGuidesBlogDiscord/node:stream/default/isReadableFisReadable

Search the reference...

/

BuildDocsReferenceGuidesBlogDiscord/node:stream/default/isReadableFisReadable

function

stream.default.isReadablefunction isReadable(stream: ReadableStream | ReadableStreamany>): null | boolean;

Returns whether the stream is readable.

@returns

Only returns null if stream is not a valid Readable, Duplex or ReadableStream.

Referenced typesinterface ReadableStreamR = any>readonly locked: booleancancel(reason?: any): Promisevoid>;getReader(options: { mode: 'byob' }): ReadableStreamBYOBReader;getReader(): ReadableStreamDefaultReaderR>;getReader(options?: ReadableStreamGetReaderOptions): ReadableStreamReaderR>;pipeThroughT>(transform: ReadableWritablePairT, R>,options?: StreamPipeOptions): ReadableStreamT>;pipeTo(destination: WritableStreamR>,options?: StreamPipeOptions): Promisevoid>;tee(): [ReadableStreamR>, ReadableStreamR>];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 →