Node.js stream/web module | API Reference | Bun

Node.js stream/web module | API Reference | BunBuildDocsReferenceGuidesBlogDiscord/node:stream/webMstream/web

Search the reference...

/

BuildDocsReferenceGuidesBlogDiscord/node:stream/webMstream/web

Node.js module

stream/web

The 'node:stream/web' submodule implements WHATWG Streams API interfaces (ReadableStream, WritableStream) in Node.js, aligning with browser stream standards.

This allows interoperation between web-standard and Node-native streams in modern applications.

const ByteLengthQueuingStrategy: new (init: QueuingStrategyInit) => ByteLengthQueuingStrategyconst CompressionStream: new (format: CompressionFormat) => CompressionStreamconst CountQueuingStrategy: new (init: QueuingStrategyInit) => CountQueuingStrategyconst DecompressionStream: new (format: CompressionFormat) => DecompressionStreamconst ReadableByteStreamController: new () => ReadableByteStreamControllerconst ReadableStream: {new (underlyingSource: UnderlyingByteSource, strategy?: { highWaterMark: number }) => ReadableStreamNonSharedUint8Array>; new (underlyingSource: UnderlyingDefaultSourceR>, strategy?: QueuingStrategyR>) => ReadableStreamR>; new (underlyingSource?: UnderlyingSourceR>, strategy?: QueuingStrategyR>) => ReadableStreamR>}const ReadableStreamBYOBReader: new (stream: ReadableStreamNonSharedUint8Array>) => ReadableStreamBYOBReaderconst ReadableStreamBYOBRequest: new () => ReadableStreamBYOBRequestconst ReadableStreamDefaultController: new () => ReadableStreamDefaultControllerconst ReadableStreamDefaultReader: new (stream: ReadableStreamR>) => ReadableStreamDefaultReaderR>const TextDecoderStream: new (label?: string, options?: TextDecoderOptions) => TextDecoderStreamconst TextEncoderStream: new () => TextEncoderStreamconst TransformStream: new (transformer?: TransformerI, O>, writableStrategy?: QueuingStrategyI>, readableStrategy?: QueuingStrategyO>) => TransformStreamI, O>const TransformStreamDefaultController: new () => TransformStreamDefaultControllerconst WritableStream: new (underlyingSink?: UnderlyingSinkW>, strategy?: QueuingStrategyW>) => WritableStreamW>const WritableStreamDefaultController: new () => WritableStreamDefaultControllerconst WritableStreamDefaultWriter: new (stream: WritableStreamW>) => WritableStreamDefaultWriterW>Type definitionsinterface ByteLengthQueuingStrategyreadonly highWaterMark: numberreadonly size: QueuingStrategySizeArrayBufferViewArrayBufferLike>>interface CompressionStreamreadonly readable: ReadableStreamNonSharedUint8Array>readonly writable: WritableStreamBufferSource>interface CountQueuingStrategyreadonly highWaterMark: numberreadonly size: QueuingStrategySizeinterface DecompressionStreamreadonly readable: ReadableStreamNonSharedUint8Array>readonly writable: WritableStreamBufferSource>interface GenericTransformStreamreadonly readable: ReadableStreamreadonly writable: WritableStreaminterface QueuingStrategyT = any>highWaterMark?: numbersize?: QueuingStrategySizeT>interface QueuingStrategyInithighWaterMark: numberinterface QueuingStrategySizeT = any>interface ReadableByteStreamControllerreadonly byobRequest: null | ReadableStreamBYOBRequestreadonly desiredSize: null | numberclose(): void;enqueue(chunk: NonSharedArrayBufferView): void;error(e?: any): void;interface 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>;interface ReadableStreamAsyncIteratorT>[Symbol.asyncDispose](): PromiseLikevoid>;[Symbol.asyncIterator](): ReadableStreamAsyncIteratorT>;next(...__namedParameters: [] | [unknown]): PromiseIteratorResultT, undefined>>;return(value?: PromiseLikeundefined>): PromiseIteratorResultT, undefined>>;throw(e?: any): PromiseIteratorResultT, undefined>>;interface ReadableStreamBYOBReaderreadonly closed: Promisevoid>cancel(reason?: any): Promisevoid>;readT extends NonSharedArrayBufferView>(view: T,options?: ReadableStreamBYOBReaderReadOptions): PromiseReadableStreamReadResultT>>;releaseLock(): void;interface ReadableStreamBYOBReaderReadOptionsmin?: numberinterface ReadableStreamBYOBRequestreadonly view: null | NonSharedArrayBufferViewrespond(bytesWritten: number): void;respondWithNewView(view: NonSharedArrayBufferView): void;interface ReadableStreamDefaultControllerR = any>readonly desiredSize: null | numberclose(): void;enqueue(chunk: R): void;error(e?: any): void;interface ReadableStreamDefaultReaderR = any>readonly closed: Promisevoid>cancel(reason?: any): Promisevoid>;read(): PromiseReadableStreamReadResultR>>;releaseLock(): void;interface ReadableStreamGenericReaderreadonly closed: Promisevoid>cancel(reason?: any): Promisevoid>;interface ReadableStreamGetReaderOptionsmode?: 'byob'interface ReadableStreamIteratorOptionspreventCancel?: booleaninterface ReadableStreamReadDoneResultT>done: truevalue: undefined | Tinterface ReadableStreamReadValueResultT>done: falsevalue: Tinterface ReadableWritablePairR = any, W = any>readable: ReadableStreamR>writable: WritableStreamW>interface StreamPipeOptionspreventAbort?: booleanpreventCancel?: booleanpreventClose?: booleansignal?: AbortSignalinterface TextDecoderStreamreadonly encoding: stringreadonly fatal: booleanreadonly ignoreBOM: booleanreadonly readable: ReadableStreamstring>readonly writable: WritableStreamBufferSource>interface TextEncoderStreamreadonly encoding: stringreadonly readable: ReadableStreamNonSharedUint8Array>readonly writable: WritableStreamstring>interface TransformerI = any, O = any>cancel?: TransformerCancelCallbackflush?: TransformerFlushCallbackO>readableType?: undefinedstart?: TransformerStartCallbackO>transform?: TransformerTransformCallbackI, O>writableType?: undefinedinterface TransformerCancelCallbackinterface TransformerFlushCallbackO>interface TransformerStartCallbackO>interface TransformerTransformCallbackI, O>interface TransformStreamI = any, O = any>readonly readable: ReadableStreamO>readonly writable: WritableStreamI>interface TransformStreamDefaultControllerO = any>readonly desiredSize: null | numberenqueue(chunk: O): void;error(reason?: any): void;terminate(): void;interface UnderlyingByteSourceautoAllocateChunkSize?: numbercancel?: UnderlyingSourceCancelCallbackpull?: (controller: ReadableByteStreamController) => void | PromiseLikevoid>start?: (controller: ReadableByteStreamController) => anytype: 'bytes'interface UnderlyingDefaultSourceR = any>cancel?: UnderlyingSourceCancelCallbackpull?: (controller: ReadableStreamDefaultControllerR>) => void | PromiseLikevoid>start?: (controller: ReadableStreamDefaultControllerR>) => anytype?: undefinedinterface UnderlyingSinkW = any>abort?: UnderlyingSinkAbortCallbackclose?: UnderlyingSinkCloseCallbackstart?: UnderlyingSinkStartCallbacktype?: undefinedwrite?: UnderlyingSinkWriteCallbackW>interface UnderlyingSinkAbortCallbackinterface UnderlyingSinkCloseCallbackinterface UnderlyingSinkStartCallbackinterface UnderlyingSinkWriteCallbackW>interface UnderlyingSourceR = any>autoAllocateChunkSize?: numbercancel?: UnderlyingSourceCancelCallbackpull?: UnderlyingSourcePullCallbackR>start?: UnderlyingSourceStartCallbackR>type?: 'bytes'interface UnderlyingSourceCancelCallbackinterface UnderlyingSourcePullCallbackR>interface UnderlyingSourceStartCallbackR>interface WritableStreamW = any>readonly locked: booleanabort(reason?: any): Promisevoid>;close(): Promisevoid>;getWriter(): WritableStreamDefaultWriterW>;interface WritableStreamDefaultControllerreadonly signal: AbortSignalerror(e?: any): void;interface WritableStreamDefaultWriterW = any>readonly closed: Promisevoid>readonly desiredSize: null | numberreadonly ready: Promisevoid>abort(reason?: any): Promisevoid>;close(): Promisevoid>;releaseLock(): void;write(chunk: W): Promisevoid>;type CompressionFormat = 'brotli' | 'deflate' | 'deflate-raw' | 'gzip'type ReadableStreamControllerT> = ReadableStreamDefaultControllerT> | ReadableByteStreamControllertype ReadableStreamReaderT> = ReadableStreamDefaultReaderT> | ReadableStreamBYOBReadertype ReadableStreamReaderMode = 'byob'type ReadableStreamReadResultT> = ReadableStreamReadValueResultT> | ReadableStreamReadDoneResultT>type ReadableStreamType = 'bytes'

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 →