Class AsyncOutputPipelineBuilder

Deprecated

Use CompositeTransferBuilder instead. Will be removed in the next major release.

Builder for constructing output pipelines with async transfer support.

Differences from OutputPipelineBuilder:

linkTransfers is called with LinkConfig (onError for async-push rejection)
finish() accepts asyncTriggerable in addition to triggerable

Implements

AsyncOutputPipelineBuilderInterface

Index

Methods

finish to start

Methods

finish

finish<
    TFinishTransfer extends DuplexTransfer<unknown, any>,
    TTriggerable extends TriggerableInterface | undefined = undefined,
    TAsyncTriggerable extends AsyncTriggerableInterface | undefined = undefined,
    TGate extends GateInterface | undefined = undefined,
>(
    lastTransfer: TFinishTransfer,
    options?: {
        asyncTriggerable?: TAsyncTriggerable;
        gate?: TGate;
        linkOnError?: ErrorHandler<TFinishTransfer>;
        owned?: boolean;
        triggerable?: TTriggerable;
    },
): CompositeOutputTransfer<
    OutputTransferDataType<TFinishTransfer>,
    TFinishTransfer,
    TTriggerable,
    TAsyncTriggerable,
    TGate,
>
Type Parameters
- TFinishTransfer extends DuplexTransfer<unknown, any>
- TTriggerable extends TriggerableInterface | undefined = undefined
- TAsyncTriggerable extends AsyncTriggerableInterface | undefined = undefined
- TGate extends GateInterface | undefined = undefined
Parameters
- lastTransfer: TFinishTransfer
- Optionaloptions: {
      asyncTriggerable?: TAsyncTriggerable;
      gate?: TGate;
      linkOnError?: ErrorHandler<TFinishTransfer>;
      owned?: boolean;
      triggerable?: TTriggerable;
  }
Returns CompositeOutputTransfer<
    OutputTransferDataType<TFinishTransfer>,
    TFinishTransfer,
    TTriggerable,
    TAsyncTriggerable,
    TGate,
>
Implementation of AsyncOutputPipelineBuilderInterface.finish
- Defined in builders.ts:1148

to

to(
nextTransfer: DuplexTransfer<unknown, unknown>,
owned?: boolean,
): AsyncOutputPipelineBuilderInterface
Parameters
- nextTransfer: DuplexTransfer<unknown, unknown>
- Optionalowned: boolean
Returns AsyncOutputPipelineBuilderInterface
Implementation of AsyncOutputPipelineBuilderInterface.to
- Defined in builders.ts:1130

`Static`start

start(
startTransfer: OutputTransfer<unknown>,
): AsyncOutputPipelineBuilderInterface
Parameters
- startTransfer: OutputTransfer<unknown>
Returns AsyncOutputPipelineBuilderInterface
- Defined in builders.ts:1122

Class AsyncOutputPipelineBuilder

Deprecated

Implements

Index

Methods

Methods

finish

Type Parameters

Parameters

Returns CompositeOutputTransfer<
    OutputTransferDataType<TFinishTransfer>,
    TFinishTransfer,
    TTriggerable,
    TAsyncTriggerable,
    TGate,
>

to

Parameters

Returns AsyncOutputPipelineBuilderInterface

`Static`start

Parameters

Returns AsyncOutputPipelineBuilderInterface

Settings

On This Page

Class AsyncOutputPipelineBuilder

Deprecated

Implements

Index

Methods

Methods

finish

Type Parameters

Parameters

Returns CompositeOutputTransfer< OutputTransferDataType<TFinishTransfer>, TFinishTransfer, TTriggerable, TAsyncTriggerable, TGate,>

to

Parameters

Returns AsyncOutputPipelineBuilderInterface

Staticstart

Parameters

Returns AsyncOutputPipelineBuilderInterface

Settings

On This Page

Returns CompositeOutputTransfer<
OutputTransferDataType<TFinishTransfer>,
TFinishTransfer,
TTriggerable,
TAsyncTriggerable,
TGate,
>

`Static`start