Class CompositeTransferBuilder<TCurrent, TStartTransfer>

Unified builder for constructing composite transfers of any direction (input, output, duplex) with both sync and async transfer support.

Purpose: Creates a composite transfer (CompositeTransfer) whose capability flags are computed from the start and finish transfers:

Input flags (Pushable, PollingProxy, AsyncPushable, AsyncPollingProxy) — from the start transfer.
Output flags (Pullable, Subscribable, AsyncPullable) — from the finish transfer.
Triggerable, AsyncTriggerable, Gate — from explicit options or auto-extracted.

Pipeline structure: OutputTransfer [→ DuplexTransfer → …] → InputTransfer │ │ │ └─ start() └─ to() └─ finish()

Where:

start() accepts an OutputTransfer (must produce data to continue the chain).
to() accepts a DuplexTransfer (must relay data to the next link).
finish() accepts an InputTransfer (must consume data to terminate the chain).

If the start transfer is also an InputTransfer (i.e. duplex), the composite exposes input capabilities. If the finish transfer is also an OutputTransfer (i.e. duplex), the composite exposes output capabilities. This naturally covers all three cases (input-only, output-only, full-duplex) without separate builder classes.

Sync and async are unified: onLinkError in finish() options enables async error handling when the chain contains async transfers.

Linking is performed via a LinkStrategyInterface (defaults to DefaultLinkStrategy when no link strategy is provided). Pass a custom link strategy to start() to override linking behavior for the entire chain.

Example

const composite = CompositeTransferBuilder
  .start(new PushStoredChannelTransfer<number>())
  .to(new ConditionTransfer<number>({ shouldAccept: x => x > 0 }))
  .to(new BufferTransfer<number>())
  .finish(new SinkTransfer<number>({ callback: console.log }), { owned: true });

composite.push(42);
composite.destroy();

const linkStrategy = new DefaultLinkStrategy();
const composite = CompositeTransferBuilder
  .start(new PushStoredChannelTransfer<number>(), { linkStrategy })
  .to(new ConditionTransfer<number>({ shouldAccept: x => x > 0 }))
  .finish(new SinkTransfer<number>({ callback: console.log }));

Type Parameters

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

Implements

CompositeTransferBuilderInterface<TCurrent, TStartTransfer>

Index

Methods

finish to start

Methods

finish

finish<
    TFinishTransfer extends InputTransfer<TCurrent>,
    TTriggerable extends TriggerableInterface | undefined = undefined,
    TAsyncTriggerable extends AsyncTriggerableInterface | undefined = undefined,
    TGate extends GateInterface | undefined = undefined,
>(
    lastTransfer: TFinishTransfer,
    options?: {
        asyncTriggerable?: TAsyncTriggerable;
        gate?: TGate;
        onLinkError?: ErrorHandler<TFinishTransfer>;
        owned?: boolean;
        triggerable?: TTriggerable;
    },
): CompositeTransfer<
    InputTransferDataType<TStartTransfer>,
    OutputTransferDataType<TFinishTransfer>,
    TStartTransfer,
    TFinishTransfer,
    TTriggerable,
    TAsyncTriggerable,
    TGate,
>
Completes the chain construction and creates a composite transfer.

Links the current transfer to lastTransfer via the link strategy, creates a UniversalCompositeTransfer with input = startTransfer, output = lastTransfer, and returns it typed as CompositeTransfer with flags computed from start and finish transfers.

Options:
- triggerable — explicit sync trigger for the composite
- asyncTriggerable — explicit async trigger for the composite
- gate — explicit gate for flow control
- owned — if true, lastTransfer is added to owned resources
- onLinkError — error handler for async-push rejection (enables async mode)
Type Parameters
- TFinishTransfer extends InputTransfer<TCurrent>
  — final transfer type (must be InputTransfer)
- TTriggerable extends TriggerableInterface | undefined = undefined
  — sync trigger type
- TAsyncTriggerable extends AsyncTriggerableInterface | undefined = undefined
  — async trigger type
- TGate extends GateInterface | undefined = undefined
  — gate type
Parameters
- lastTransfer: TFinishTransfer
  — final input transfer
- Optionaloptions: {
      asyncTriggerable?: TAsyncTriggerable;
      gate?: TGate;
      onLinkError?: ErrorHandler<TFinishTransfer>;
      owned?: boolean;
      triggerable?: TTriggerable;
  }
  — completion options
Returns CompositeTransfer<
    InputTransferDataType<TStartTransfer>,
    OutputTransferDataType<TFinishTransfer>,
    TStartTransfer,
    TFinishTransfer,
    TTriggerable,
    TAsyncTriggerable,
    TGate,
>
CompositeTransfer with computed flags
Implementation of CompositeTransferBuilderInterface.finish
- Defined in builders.ts:384

to

to<TNextTransfer extends DuplexTransfer<TCurrent, unknown>>(
    nextTransfer: TNextTransfer,
    options?: { onLinkError?: ErrorHandler<TNextTransfer>; owned?: boolean },
): CompositeTransferBuilderInterface<
    OutputTransferDataType<TNextTransfer>,
    TStartTransfer,
>
Adds an intermediate duplex transfer to the chain.

Links the current transfer to nextTransfer via the link strategy, then returns a new builder with the next transfer's output data type as the current type.

Options:
- owned — if true, nextTransfer will be destroyed on composite destroy()
- onLinkError — error handler for async-push rejection (enables async linking when the chain contains async transfers)
Type Parameters
- TNextTransfer extends DuplexTransfer<TCurrent, unknown>
  — type of the next duplex transfer
Parameters
- nextTransfer: TNextTransfer
  — duplex transfer to add to the chain
- Optionaloptions: { onLinkError?: ErrorHandler<TNextTransfer>; owned?: boolean }
  — optional link configuration: owned (destroy nextTransfer on composite destroy), onLinkError (error handler for async-push rejection, enables async linking)
Returns CompositeTransferBuilderInterface<
OutputTransferDataType<TNextTransfer>,
TStartTransfer,
>
A new builder with the updated output data type
Implementation of CompositeTransferBuilderInterface.to
- Defined in builders.ts:336

`Static`start

start<TStartTransfer extends OutputTransfer<unknown>>(
    startTransfer: TStartTransfer,
    options?: { linkStrategy?: LinkStrategyInterface },
): CompositeTransferBuilderInterface<
    OutputTransferDataType<TStartTransfer>,
    TStartTransfer,
>
Creates a builder with an initial output transfer.

The start transfer provides the output capabilities that feed data into the chain. If it is also an InputTransfer (duplex), its input flags become the composite's input flags.

Options:
- linkStrategy — custom link strategy for all subsequent to() and finish() calls. If omitted, defaults to DefaultLinkStrategy.
Type Parameters
- TStartTransfer extends OutputTransfer<unknown>
  — type of the initial transfer (must be OutputTransfer)
Parameters
- startTransfer: TStartTransfer
  — initial output transfer
- Optionaloptions: { linkStrategy?: LinkStrategyInterface }
  — optional start configuration
Returns CompositeTransferBuilderInterface<
OutputTransferDataType<TStartTransfer>,
TStartTransfer,
>
A new CompositeTransferBuilder instance
- Defined in builders.ts:307

Class CompositeTransferBuilder<TCurrent, TStartTransfer>

Example

Type Parameters

Implements

Index

Methods

Methods

finish

Type Parameters

Parameters

Returns CompositeTransfer<
    InputTransferDataType<TStartTransfer>,
    OutputTransferDataType<TFinishTransfer>,
    TStartTransfer,
    TFinishTransfer,
    TTriggerable,
    TAsyncTriggerable,
    TGate,
>

to

Type Parameters

Parameters

Returns CompositeTransferBuilderInterface<
OutputTransferDataType<TNextTransfer>,
TStartTransfer,
>

`Static`start

Type Parameters

Parameters

Returns CompositeTransferBuilderInterface<
OutputTransferDataType<TStartTransfer>,
TStartTransfer,
>

Settings

On This Page

Class CompositeTransferBuilder<TCurrent, TStartTransfer>

Example

Type Parameters

Implements

Index

Methods

Methods

finish

Type Parameters

Parameters

Returns CompositeTransfer< InputTransferDataType<TStartTransfer>, OutputTransferDataType<TFinishTransfer>, TStartTransfer, TFinishTransfer, TTriggerable, TAsyncTriggerable, TGate,>

to

Type Parameters

Parameters

Returns CompositeTransferBuilderInterface< OutputTransferDataType<TNextTransfer>, TStartTransfer,>

Staticstart

Type Parameters

Parameters

Returns CompositeTransferBuilderInterface< OutputTransferDataType<TStartTransfer>, TStartTransfer,>

Settings

On This Page

Returns CompositeTransfer<
InputTransferDataType<TStartTransfer>,
OutputTransferDataType<TFinishTransfer>,
TStartTransfer,
TFinishTransfer,
TTriggerable,
TAsyncTriggerable,
TGate,
>

Returns CompositeTransferBuilderInterface<
OutputTransferDataType<TNextTransfer>,
TStartTransfer,
>

`Static`start

Returns CompositeTransferBuilderInterface<
OutputTransferDataType<TStartTransfer>,
TStartTransfer,
>