node:stream/iter module | API Reference | Bun

node:stream/iter module | API Reference | BunBuildDocsReferenceGuidesBlogDiscord/node:stream/iterFarrayFarrayBufferFarrayBufferSyncFarraySyncNBroadcastFbroadcastVbroadcastProtocolFbytesFbytesSyncVdrainableProtocolFduplexFfromFfromSyncFmergeFondrainFpipeToFpipeToSyncFpullFpullSyncFpushNShareFshareVshareProtocolFshareSyncVshareSyncProtocolNStreamNSyncShareFtapFtapSyncFtextFtextSyncVtoAsyncStreamableVtoStreamable

Search the reference...

/

BuildDocsReferenceGuidesBlogDiscord/node:stream/iterFarrayFarrayBufferFarrayBufferSyncFarraySyncNBroadcastFbroadcastVbroadcastProtocolFbytesFbytesSyncVdrainableProtocolFduplexFfromFfromSyncFmergeFondrainFpipeToFpipeToSyncFpullFpullSyncFpushNShareFshareVshareProtocolFshareSyncVshareSyncProtocolNStreamNSyncShareFtapFtapSyncFtextFtextSyncVtoAsyncStreamableVtoStreamable

Node.js module

node:stream/iternamespace Broadcastfunction from(input: ByteReadableStream | SyncByteReadableStream | Broadcastable,options?: BroadcastOptions): BroadcastResult;

Create a Broadcast from an existing source. The source is consumed automatically and pushed to all subscribers.

@param options

Same as broadcast().

namespace Sharefunction from(input: ByteReadableStream | SyncByteReadableStream | Shareable,options?: ShareOptions): Share;

Create a Share from an existing source.

@param options

Same as share().

namespace Streamnamespace SyncSharefunction from(input: SyncByteReadableStream | SyncShareable,options?: ShareSyncOptions): SyncShare;

const broadcastProtocol: unique symbolconst drainableProtocol: unique symbolconst shareProtocol: unique symbolconst shareSyncProtocol: unique symbolconst toAsyncStreamable: unique symbolconst toStreamable: unique symbolfunction array(source: Source,options?: ConsumeOptions): PromiseUint8ArrayArrayBufferLike>[]>;function arrayBuffer(source: Source,options?: ConsumeOptions): PromiseArrayBuffer>;function arrayBufferSync(source: SyncSource,options?: ConsumeSyncOptions): ArrayBuffer;function arraySync(source: SyncSource,options?: ConsumeSyncOptions): Uint8ArrayArrayBufferLike>[];function broadcast(options?: BroadcastOptions): BroadcastResult;function bytes(source: Source,options?: ConsumeOptions): PromiseUint8ArrayArrayBufferLike>>;function bytesSync(source: SyncSource,options?: ConsumeSyncOptions): Uint8Array;function duplex(options?: DuplexOptions): [DuplexChannel, DuplexChannel];function from(input: Source): ByteReadableStream;function fromSync(input: SyncSource): SyncByteReadableStream;function merge(...sources: Source[]): ByteReadableStream;function merge(...args: [...sources: Source[], options: MergeOptions]): ByteReadableStream;function ondrain(drainable: any): null | Promiseboolean>;function pipeTo(source: Source,writer: PartialWriter,options?: PipeToOptions): Promisenumber>;function pipeTo(source: Source,...args: [...transforms: Transform[], writer: PartialWriter]): Promisenumber>;function pipeTo(source: Source,...args: [...transforms: Transform[], writer: PartialWriter, options: PipeToOptions]): Promisenumber>;function pipeToSync(source: SyncSource,writer: PartialSyncWriter,options?: PipeToSyncOptions): number;function pipeToSync(source: SyncSource,...args: [...transforms: SyncTransform[], writer: PartialSyncWriter]): number;function pipeToSync(source: SyncSource,...args: [...transforms: SyncTransform[], writer: PartialSyncWriter, options: PipeToSyncOptions]): number;function pull(source: Source,...transforms: Transform[]): ByteReadableStream;function pull(source: Source,...args: [...transforms: Transform[], options: PullOptions]): ByteReadableStream;function pullSync(source: SyncSource,...transforms: SyncTransform[]): SyncByteReadableStream;function push(...transforms: Transform[]): PushStreamResult;function push(...args: [...transforms: Transform[], options: PushStreamOptions]): PushStreamResult;function share(source: Source,options?: ShareOptions): Share;function shareSync(source: SyncSource,options?: ShareSyncOptions): SyncShare;function tap(callback: StatelessTransformFn): StatelessTransformFn;function tapSync(callback: SyncStatelessTransformFn): SyncStatelessTransformFn;function text(source: Source,options?: TextConsumeOptions): Promisestring>;function textSync(source: SyncSource,options?: TextConsumeSyncOptions): string;Type definitionsinterface AsyncStreamable[toAsyncStreamable](): Source;interface Broadcastreadonly bufferSize: numberreadonly consumerCount: number[Symbol.dispose](): void;cancel(reason?: any): void;push(...args: any[]): ByteReadableStream;interface Broadcastable[broadcastProtocol](options: BroadcastOptions): Broadcast;interface BroadcastOptionsbackpressure?: BackpressurePolicyhighWaterMark?: numbersignal?: AbortSignalinterface BroadcastResultbroadcast: Broadcastwriter: BroadcastWriterinterface BroadcastWriterreadonly desiredSize: null | number[Symbol.asyncDispose](): PromiseLikevoid>;[Symbol.dispose](): void;[drainableProtocol](): null | Promiseboolean>;end(options?: WriteOptions): Promisenumber>;endSync(): number;fail(reason?: any): void;write(chunk: string | Uint8ArrayArrayBufferLike>,options?: WriteOptions): Promisevoid>;writeSync(chunk: string | Uint8ArrayArrayBufferLike>): boolean;writev(chunks: string | Uint8ArrayArrayBufferLike>[],options?: WriteOptions): Promisevoid>;writevSync(chunks: string | Uint8ArrayArrayBufferLike>[]): boolean;interface ConsumeOptionslimit?: numbersignal?: AbortSignalinterface ConsumeSyncOptionslimit?: numberinterface Drainable[drainableProtocol](): null | Promiseboolean>;interface DuplexChannelreadonly readable: ByteReadableStreamreadonly writer: Writer[Symbol.asyncDispose](): PromiseLikevoid>;close(): Promisevoid>;interface DuplexDirectionOptionsbackpressure?: BackpressurePolicyhighWaterMark?: numberinterface DuplexOptionsa?: DuplexDirectionOptionsb?: DuplexDirectionOptionsbackpressure?: BackpressurePolicyhighWaterMark?: numbersignal?: AbortSignalinterface MergeOptionssignal?: AbortSignalinterface PartialSyncWriter[Symbol.dispose]?: () => voidreadonly desiredSize?: null | numberendSync?: () => numberfail?: (reason?: any) => voidwritevSync?: (chunks: string | Uint8ArrayArrayBufferLike>[]) => numberwriteSync(chunk: string | Uint8ArrayArrayBufferLike>): number;interface PartialWriter[Symbol.asyncDispose]?: () => PromiseLikevoid>[Symbol.dispose]?: () => voidreadonly desiredSize?: null | numberend?: (options?: WriteOptions) => Promisenumber>endSync?: () => numberfail?: (reason?: any) => voidwriteSync?: (chunk: string | Uint8ArrayArrayBufferLike>) => booleanwritev?: (chunks: string | Uint8ArrayArrayBufferLike>[], options?: WriteOptions) => Promisevoid>writevSync?: (chunks: string | Uint8ArrayArrayBufferLike>[]) => booleanwrite(chunk: string | Uint8ArrayArrayBufferLike>,options?: WriteOptions): Promisevoid>;interface PipeToOptionspreventClose?: booleanpreventFail?: booleansignal?: AbortSignalinterface PipeToSyncOptionspreventClose?: booleanpreventFail?: booleaninterface PullOptionssignal?: AbortSignalinterface PushStreamOptionsbackpressure?: BackpressurePolicyhighWaterMark?: numbersignal?: AbortSignalinterface PushStreamResultreadable: ByteReadableStreamwriter: PushWriterinterface PushWriterreadonly desiredSize: null | number[Symbol.asyncDispose](): PromiseLikevoid>;[Symbol.dispose](): void;[drainableProtocol](): null | Promiseboolean>;end(options?: WriteOptions): Promisenumber>;endSync(): number;fail(reason?: any): void;write(chunk: string | Uint8ArrayArrayBufferLike>,options?: WriteOptions): Promisevoid>;writeSync(chunk: string | Uint8ArrayArrayBufferLike>): boolean;writev(chunks: string | Uint8ArrayArrayBufferLike>[],options?: WriteOptions): Promisevoid>;writevSync(chunks: string | Uint8ArrayArrayBufferLike>[]): boolean;interface Sharereadonly bufferSize: numberreadonly consumerCount: number[Symbol.dispose](): void;cancel(reason?: any): void;pull(...args: any[]): ByteReadableStream;interface Shareable[shareProtocol](options: ShareOptions): Share;interface ShareOptionsbackpressure?: BackpressurePolicyhighWaterMark?: numbersignal?: AbortSignalinterface ShareSyncOptionsbackpressure?: BackpressurePolicyhighWaterMark?: numberinterface StatefulTransformtransform(source: AsyncIterablenull | Uint8ArrayArrayBufferLike>[]>,options: TransformCallbackOptions): AsyncIterableTransformResult>;interface StatelessTransformFninterface Streamable[toStreamable](): SyncSource;interface SyncSharereadonly bufferSize: numberreadonly consumerCount: number[Symbol.dispose](): void;cancel(reason?: any): void;pull(...args: any): SyncByteReadableStream;interface SyncShareable[shareSyncProtocol](options: ShareSyncOptions): SyncShare;interface SyncStatefulTransformtransform(source: Iterablenull | Uint8ArrayArrayBufferLike>[]>): IterableSyncTransformResult>;interface SyncStatelessTransformFninterface SyncWriterreadonly desiredSize: null | number[Symbol.dispose](): void;endSync(): number;fail(reason?: any): void;writeSync(chunk: string | Uint8ArrayArrayBufferLike>): number;writevSync(chunks: string | Uint8ArrayArrayBufferLike>[]): number;interface TextConsumeOptionsencoding?: stringlimit?: numbersignal?: AbortSignalinterface TextConsumeSyncOptionsencoding?: stringlimit?: numberinterface TransformCallbackOptionssignal: AbortSignalinterface WriteOptionssignal?: AbortSignalinterface Writerreadonly desiredSize: null | number[Symbol.asyncDispose](): PromiseLikevoid>;[Symbol.dispose](): void;end(options?: WriteOptions): Promisenumber>;endSync(): number;fail(reason?: any): void;write(chunk: string | Uint8ArrayArrayBufferLike>,options?: WriteOptions): Promisevoid>;writeSync(chunk: string | Uint8ArrayArrayBufferLike>): boolean;writev(chunks: string | Uint8ArrayArrayBufferLike>[],options?: WriteOptions): Promisevoid>;writevSync(chunks: string | Uint8ArrayArrayBufferLike>[]): boolean;type BackpressurePolicy = 'strict' | 'block' | 'drop-oldest' | 'drop-newest'type ByteReadableStream = AsyncIterableUint8Array[]>type Source = string | ArrayBufferLike | ArrayBufferView | IterableSyncSource> | AsyncIterableSource> | Streamable | AsyncStreamabletype SyncByteReadableStream = IterableUint8Array[]>type SyncSource = string | ArrayBufferLike | ArrayBufferView | IterableSyncSource> | Streamabletype SyncTransform = SyncStatelessTransformFn | SyncStatefulTransformtype SyncTransformResult = string | ArrayBufferLike | ArrayBufferView | IterableSyncTransformResult>type Transform = StatelessTransformFn | StatefulTransformtype TransformResult = string | ArrayBufferLike | ArrayBufferView | IterableSyncTransformResult> | AsyncIterableTransformResult>

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 →