Function pipeline

pipeline<A, B>(source: A, destination: B, options?: PipelineOptions): PipelinePromise
Type Parameters
- A extends PipelineSource<any>
- B extends WritableStream | PipelineDestinationIterableFunction<string | Buffer> | PipelineDestinationPromiseFunction<string | Buffer, any> | PipelineDestinationIterableFunction<any> | PipelineDestinationPromiseFunction<any, any>
Parameters
- source: A
- destination: B
- Optional options: PipelineOptions
Returns PipelinePromise
- Defined in node_modules/@types/node/ts4.8/stream/promises.d.ts:4
pipeline<A, T1, B>(source: A, transform1: T1, destination: B, options?: PipelineOptions): PipelinePromise
Type Parameters
- A extends PipelineSource<any>
- T1 extends PipelineTransform<A, any>
- B extends WritableStream | PipelineDestinationIterableFunction<string | Buffer> | PipelineDestinationPromiseFunction<string | Buffer, any> | PipelineDestinationIterableFunction<any> | PipelineDestinationPromiseFunction<any, any>
Parameters
- source: A
- transform1: T1
- destination: B
- Optional options: PipelineOptions
Returns PipelinePromise
- Defined in node_modules/@types/node/ts4.8/stream/promises.d.ts:5
pipeline<A, T1, T2, B>(source: A, transform1: T1, transform2: T2, destination: B, options?: PipelineOptions): PipelinePromise
Type Parameters
- A extends PipelineSource<any>
- T1 extends PipelineTransform<A, any>
- T2 extends PipelineTransform<T1, any>
- B extends WritableStream | PipelineDestinationIterableFunction<string | Buffer> | PipelineDestinationPromiseFunction<string | Buffer, any> | PipelineDestinationIterableFunction<any> | PipelineDestinationPromiseFunction<any, any>
Parameters
- source: A
- transform1: T1
- transform2: T2
- destination: B
- Optional options: PipelineOptions
Returns PipelinePromise
- Defined in node_modules/@types/node/ts4.8/stream/promises.d.ts:11
pipeline<A, T1, T2, T3, B>(source: A, transform1: T1, transform2: T2, transform3: T3, destination: B, options?: PipelineOptions): PipelinePromise
Type Parameters
- A extends PipelineSource<any>
- T1 extends PipelineTransform<A, any>
- T2 extends PipelineTransform<T1, any>
- T3 extends PipelineTransform<T2, any>
- B extends WritableStream | PipelineDestinationIterableFunction<string | Buffer> | PipelineDestinationPromiseFunction<string | Buffer, any> | PipelineDestinationIterableFunction<any> | PipelineDestinationPromiseFunction<any, any>
Parameters
- source: A
- transform1: T1
- transform2: T2
- transform3: T3
- destination: B
- Optional options: PipelineOptions
Returns PipelinePromise
- Defined in node_modules/@types/node/ts4.8/stream/promises.d.ts:18
pipeline<A, T1, T2, T3, T4, B>(source: A, transform1: T1, transform2: T2, transform3: T3, transform4: T4, destination: B, options?: PipelineOptions): PipelinePromise
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 WritableStream | PipelineDestinationIterableFunction<string | Buffer> | PipelineDestinationPromiseFunction<string | Buffer, any> | PipelineDestinationIterableFunction<any> | PipelineDestinationPromiseFunction<any, any>
Parameters
- source: A
- transform1: T1
- transform2: T2
- transform3: T3
- transform4: T4
- destination: B
- Optional options: PipelineOptions
Returns PipelinePromise
- Defined in node_modules/@types/node/ts4.8/stream/promises.d.ts:25
pipeline(streams: readonly (ReadableStream | WritableStream | ReadWriteStream)[], options?: PipelineOptions): Promise<void>
Parameters
- streams: readonly (ReadableStream | WritableStream | ReadWriteStream)[]
- Optional options: PipelineOptions
Returns Promise<void>
- Defined in node_modules/@types/node/ts4.8/stream/promises.d.ts:33
pipeline(stream1: ReadableStream, stream2: WritableStream | ReadWriteStream, ...streams: (WritableStream | ReadWriteStream | PipelineOptions)[]): Promise<void>
Parameters
- stream1: ReadableStream
- stream2: WritableStream | ReadWriteStream
- Rest ...streams: (WritableStream | ReadWriteStream | PipelineOptions)[]
Returns Promise<void>
- Defined in node_modules/@types/node/ts4.8/stream/promises.d.ts:34

Function pipeline

Type Parameters

A extends PipelineSource<any>

B extends WritableStream | PipelineDestinationIterableFunction<string | Buffer> | PipelineDestinationPromiseFunction<string | Buffer, any> | PipelineDestinationIterableFunction<any> | PipelineDestinationPromiseFunction<any, any>

Parameters

source: A

destination: B

Optional options: PipelineOptions

Returns PipelinePromise<B>

Type Parameters

A extends PipelineSource<any>

T1 extends PipelineTransform<A, any>

B extends WritableStream | PipelineDestinationIterableFunction<string | Buffer> | PipelineDestinationPromiseFunction<string | Buffer, any> | PipelineDestinationIterableFunction<any> | PipelineDestinationPromiseFunction<any, any>

Parameters

source: A

transform1: T1

destination: B

Optional options: PipelineOptions

Returns PipelinePromise<B>

Type Parameters

A extends PipelineSource<any>

T1 extends PipelineTransform<A, any>

T2 extends PipelineTransform<T1, any>

B extends WritableStream | PipelineDestinationIterableFunction<string | Buffer> | PipelineDestinationPromiseFunction<string | Buffer, any> | PipelineDestinationIterableFunction<any> | PipelineDestinationPromiseFunction<any, any>

Parameters

source: A

transform1: T1

transform2: T2

destination: B

Optional options: PipelineOptions

Returns 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 WritableStream | PipelineDestinationIterableFunction<string | Buffer> | PipelineDestinationPromiseFunction<string | Buffer, any> | PipelineDestinationIterableFunction<any> | PipelineDestinationPromiseFunction<any, any>

Parameters

source: A

transform1: T1

transform2: T2

transform3: T3

destination: B

Optional options: PipelineOptions

Returns 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 WritableStream | PipelineDestinationIterableFunction<string | Buffer> | PipelineDestinationPromiseFunction<string | Buffer, any> | PipelineDestinationIterableFunction<any> | PipelineDestinationPromiseFunction<any, any>

Parameters

source: A

transform1: T1

transform2: T2

transform3: T3

transform4: T4

destination: B

Optional options: PipelineOptions

Returns PipelinePromise<B>

Parameters

streams: readonly (ReadableStream | WritableStream | ReadWriteStream)[]

Optional options: PipelineOptions

Returns Promise<void>

Parameters

stream1: ReadableStream

stream2: WritableStream | ReadWriteStream

Rest ...streams: (WritableStream | ReadWriteStream | PipelineOptions)[]

Returns Promise<void>

Settings

Member Visibility

Theme

`Optional` options: PipelineOptions

`Optional` options: PipelineOptions

`Optional` options: PipelineOptions

`Optional` options: PipelineOptions

`Optional` options: PipelineOptions

`Optional` options: PipelineOptions

`Rest` ...streams: (WritableStream | ReadWriteStream | PipelineOptions)[]