• Preparing search index...
  • The search index is not available
@filen/sdk
  • @filen/sdk
  • <internal>
  • node:stream/promises
  • pipeline

Function pipeline

  • pipeline<
        A extends PipelineSource<any>,
        B extends
        
                | WritableStream
                | PipelineDestinationIterableFunction<string | Buffer>
                | PipelineDestinationPromiseFunction<string | Buffer, any>
                | PipelineDestinationIterableFunction<any>
                | PipelineDestinationPromiseFunction<any, any>,
    >(
        source: A,
        destination: B,
        options?: PipelineOptions,
    ): PipelinePromise<B>

    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
    • Optionaloptions: PipelineOptions

    Returns PipelinePromise<B>

    • Defined in node_modules/@types/node/stream/promises.d.ts:14
  • pipeline<
        A extends PipelineSource<any>,
        T1 extends PipelineTransform<A, any>,
        B extends
        
                | WritableStream
                | PipelineDestinationIterableFunction<string | Buffer>
                | PipelineDestinationPromiseFunction<string | Buffer, any>
                | PipelineDestinationIterableFunction<any>
                | PipelineDestinationPromiseFunction<any, any>,
    >(
        source: A,
        transform1: T1,
        destination: B,
        options?: PipelineOptions,
    ): 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
    • Optionaloptions: PipelineOptions

    Returns PipelinePromise<B>

    • Defined in node_modules/@types/node/stream/promises.d.ts:19
  • pipeline<
        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>,
    >(
        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
          | WritableStream
          | PipelineDestinationIterableFunction<string | Buffer>
          | PipelineDestinationPromiseFunction<string | Buffer, any>
          | PipelineDestinationIterableFunction<any>
          | PipelineDestinationPromiseFunction<any, any>

    Parameters

    • source: A
    • transform1: T1
    • transform2: T2
    • destination: B
    • Optionaloptions: PipelineOptions

    Returns PipelinePromise<B>

    • Defined in node_modules/@types/node/stream/promises.d.ts:29
  • pipeline<
        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>,
    >(
        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
          | WritableStream
          | PipelineDestinationIterableFunction<string | Buffer>
          | PipelineDestinationPromiseFunction<string | Buffer, any>
          | PipelineDestinationIterableFunction<any>
          | PipelineDestinationPromiseFunction<any, any>

    Parameters

    • source: A
    • transform1: T1
    • transform2: T2
    • transform3: T3
    • destination: B
    • Optionaloptions: PipelineOptions

    Returns PipelinePromise<B>

    • Defined in node_modules/@types/node/stream/promises.d.ts:41
  • 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
        
                | WritableStream
                | PipelineDestinationIterableFunction<string | Buffer>
                | PipelineDestinationPromiseFunction<string | Buffer, any>
                | PipelineDestinationIterableFunction<any>
                | PipelineDestinationPromiseFunction<any, 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
          | 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
    • Optionaloptions: PipelineOptions

    Returns PipelinePromise<B>

    • Defined in node_modules/@types/node/stream/promises.d.ts:55
  • pipeline(
        streams: readonly (WritableStream | ReadableStream | ReadWriteStream)[],
        options?: PipelineOptions,
    ): Promise<void>

    Parameters

    • streams: readonly (WritableStream | ReadableStream | ReadWriteStream)[]
    • Optionaloptions: PipelineOptions

    Returns Promise<void>

    • Defined in node_modules/@types/node/stream/promises.d.ts:71
  • pipeline(
        stream1: ReadableStream,
        stream2: WritableStream | ReadWriteStream,
        ...streams: (WritableStream | ReadWriteStream | PipelineOptions)[],
    ): Promise<void>

    Parameters

    • stream1: ReadableStream
    • stream2: WritableStream | ReadWriteStream
    • ...streams: (WritableStream | ReadWriteStream | PipelineOptions)[]

    Returns Promise<void>

    • Defined in node_modules/@types/node/stream/promises.d.ts:75

Settings

Member Visibility
@filen/sdk
  • Loading...

Generated using TypeDoc