pipeline - Node documentation
function pipeline

Usage

import { pipeline } from "node:stream/promises";

Type Parameters

A extends PipelineSource<any>
B extends PipelineDestination<A, any>

Parameters

source: A
destination: B
optional
options: PipelineOptions

Return Type

Type Parameters

A extends PipelineSource<any>
T1 extends PipelineTransform<A, any>
B extends PipelineDestination<T1, any>

Parameters

source: A
transform1: T1
destination: B
optional
options: PipelineOptions

Return Type

Type Parameters

A extends PipelineSource<any>
T1 extends PipelineTransform<A, any>
T2 extends PipelineTransform<T1, any>
B extends PipelineDestination<T2, any>

Parameters

source: A
transform1: T1
transform2: T2
destination: B
optional
options: PipelineOptions

Return Type

Type Parameters

A extends PipelineSource<any>
T1 extends PipelineTransform<A, any>
T2 extends PipelineTransform<T1, any>
T3 extends PipelineTransform<T2, any>
B extends PipelineDestination<T3, any>

Parameters

source: A
transform1: T1
transform2: T2
transform3: T3
destination: B
optional
options: PipelineOptions

Return Type

Type Parameters

A extends PipelineSource<any>
T1 extends PipelineTransform<A, any>
T2 extends PipelineTransform<T1, any>
T3 extends PipelineTransform<T2, any>
T4 extends PipelineTransform<T3, any>
B extends PipelineDestination<T4, any>

Parameters

source: A
transform1: T1
transform2: T2
transform3: T3
transform4: T4
destination: B
optional
options: PipelineOptions

Return Type

Parameters

streams: ReadonlyArray<ReadableStream | WritableStream | ReadWriteStream>
optional
options: PipelineOptions

Return Type

Promise<void>

Parameters

stream1: ReadableStream
stream2: ReadWriteStream | WritableStream
...streams: Array<ReadWriteStream | WritableStream | PipelineOptions>

Return Type

Promise<void>