Class AsyncInputPipelineBuilder<TCurrent, TStartTransfer>

Deprecated

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

Builder for constructing input pipelines with async transfer support.

Differences from InputPipelineBuilder:

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

Type Parameters

TCurrent
— data type of the current chain link
TStartTransfer extends InputTransfer<unknown>
— type of the initial transfer (must be InputTransfer)

Implements

AsyncInputPipelineBuilderInterface<TCurrent, TStartTransfer>

Index

Methods

finish to start

Methods

finish

finish<
    TTriggerable extends TriggerableInterface
    | undefined = undefined,
    TAsyncTriggerable extends AsyncTriggerableInterface | undefined = undefined,
    TGate extends GateInterface | undefined = undefined,
>(
    lastTransfer: InputTransfer<TCurrent>,
    options?: {
        asyncTriggerable?: TAsyncTriggerable;
        gate?: TGate;
        linkOnError?: ErrorHandler<InputTransfer<TCurrent>>;
        owned?: boolean;
        triggerable?: TTriggerable;
    },
): CompositeInputTransfer<
    InputTransferDataType<TStartTransfer>,
    TStartTransfer,
    TTriggerable,
    TAsyncTriggerable,
    TGate,
>
Type Parameters
- TTriggerable extends TriggerableInterface | undefined = undefined
- TAsyncTriggerable extends AsyncTriggerableInterface | undefined = undefined
- TGate extends GateInterface | undefined = undefined
Parameters
- lastTransfer: InputTransfer<TCurrent>
- Optionaloptions: {
      asyncTriggerable?: TAsyncTriggerable;
      gate?: TGate;
      linkOnError?: ErrorHandler<InputTransfer<TCurrent>>;
      owned?: boolean;
      triggerable?: TTriggerable;
  }
Returns CompositeInputTransfer<
    InputTransferDataType<TStartTransfer>,
    TStartTransfer,
    TTriggerable,
    TAsyncTriggerable,
    TGate,
>
Implementation of AsyncInputPipelineBuilderInterface.finish
- Defined in builders.ts:1058

to

to<TNext>(
nextTransfer: DuplexTransfer<TCurrent, TNext>,
owned?: boolean,
): AsyncInputPipelineBuilderInterface<TNext, TStartTransfer>
Type Parameters
- TNext
Parameters
- nextTransfer: DuplexTransfer<TCurrent, TNext>
- Optionalowned: boolean
Returns AsyncInputPipelineBuilderInterface<TNext, TStartTransfer>
Implementation of AsyncInputPipelineBuilderInterface.to
- Defined in builders.ts:1040

`Static`start

start<TCurrent, TStartTransfer extends DuplexTransfer<unknown, TCurrent>>(
startTransfer: TStartTransfer,
): AsyncInputPipelineBuilderInterface<TCurrent, TStartTransfer>
Type Parameters
- TCurrent
- TStartTransfer extends DuplexTransfer<unknown, TCurrent>
Parameters
- startTransfer: TStartTransfer
Returns AsyncInputPipelineBuilderInterface<TCurrent, TStartTransfer>
- Defined in builders.ts:1034