Skip to main content
pipeline - stream/promises - Node documentation
function pipeline

Usage in Deno

import { pipeline } from "node:stream/promises";
pipeline<
A extends PipelineSource<any>,
B extends PipelineDestination<A, any>,
>
(
source: A,
destination: B,
options?: PipelineOptions,
): PipelinePromise<B>

Type Parameters

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

Parameters

source: A
destination: B
optional
options: PipelineOptions

Return Type

pipeline<
A extends PipelineSource<any>,
T1 extends PipelineTransform<A, any>,
B extends PipelineDestination<T1, any>,
>
(
source: A,
transform1: T1,
destination: B,
options?: PipelineOptions,
): PipelinePromise<B>

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

pipeline<
A extends PipelineSource<any>,
T1 extends PipelineTransform<A, any>,
T2 extends PipelineTransform<T1, any>,
B extends PipelineDestination<T2, any>,
>
(
source: A,
transform1: T1,
transform2: T2,
destination: B,
options?: PipelineOptions,
): PipelinePromise<B>

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

pipeline<
A extends PipelineSource<any>,
T1 extends PipelineTransform<A, any>,
T2 extends PipelineTransform<T1, any>,
T3 extends PipelineTransform<T2, any>,
B extends PipelineDestination<T3, any>,
>
(
source: A,
transform1: T1,
transform2: T2,
transform3: T3,
destination: B,
options?: PipelineOptions,
): PipelinePromise<B>

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

pipeline<
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>,
>
(
source: A,
transform1: T1,
transform2: T2,
transform3: T3,
transform4: T4,
destination: B,
options?: PipelineOptions,
): PipelinePromise<B>

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

pipeline(
streams: ReadonlyArray<
ReadableStream
| WritableStream
| ReadWriteStream
>
,
options?: PipelineOptions,
): Promise<void>

Parameters

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

Return Type

Promise<void>
pipeline(
stream1: ReadableStream,
stream2: ReadWriteStream | WritableStream,
...streams: Array<
ReadWriteStream
| WritableStream
| PipelineOptions
>
,
): Promise<void>

Parameters

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

Return Type

Promise<void>
Back to top