stream/promises
Usage in Deno
import * as mod from "node:stream/promises";
function finished
Usage in Deno
import { finished } from "node:stream/promises";
finished(
stream:
ReadableStream
| WritableStream
| ReadWriteStream
,
options?: FinishedOptions,
): Promise<void>Parameters
stream:
ReadableStream
| WritableStream
| ReadWriteStream
options: FinishedOptions optional
Return Type
Promise<void> function pipeline
Usage in Deno
import { pipeline } from "node:stream/promises";
Overload 1
pipeline<
A extends PipelineSource<any>,
B extends PipelineDestination<A, any>,
>(): PipelinePromise<B>Type Parameters
A extends PipelineSource<any> B extends PipelineDestination<A, any> Parameters
Return Type
Overload 2
pipeline<
A extends PipelineSource<any>,
T1 extends PipelineTransform<A, any>,
B extends PipelineDestination<T1, any>,
>(): PipelinePromise<B>Type Parameters
A extends PipelineSource<any> T1 extends PipelineTransform<A, any> B extends PipelineDestination<T1, any> Parameters
Return Type
Overload 3
pipeline<
A extends PipelineSource<any>,
T1 extends PipelineTransform<A, any>,
T2 extends PipelineTransform<T1, any>,
B extends PipelineDestination<T2, any>,
>(): PipelinePromise<B>Type Parameters
A extends PipelineSource<any> T1 extends PipelineTransform<A, any> T2 extends PipelineTransform<T1, any> B extends PipelineDestination<T2, any> Parameters
Return Type
Overload 4
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
Return Type
Overload 5
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
Return Type
Overload 6
pipeline(
streams: ReadonlyArray<
ReadableStream
| WritableStream
| ReadWriteStream
>,
options?: PipelineOptions,
): Promise<void>Parameters
streams: ReadonlyArray<
ReadableStream
| WritableStream
| ReadWriteStream
> options: PipelineOptions optional
Return Type
Promise<void> Overload 7
pipeline(
stream1: ReadableStream,
stream2: ReadWriteStream | WritableStream,
...streams: Array<>,
): Promise<void>Parameters
stream1: ReadableStream stream2: ReadWriteStream | WritableStream ...streams: Array<> Return Type
Promise<void> interface FinishedOptions
extends _FinishedOptions
Usage in Deno
import { type FinishedOptions } from "node:stream/promises";
Properties
cleanup: boolean | undefined optional
If true, removes the listeners registered by this function before the promise is fulfilled.
© 2018–2025 the Deno authors
Licensed under the MIT License.
https://docs.deno.com/api/node/stream/promises
