Interface PipelineHandle

Typed handle over one registered pipeline resource.

interface PipelineHandle {
    data: PipelineRecord | null;
    defaultParametersPage_get(
        params: Record<string, unknown>,
    ): Promise<ListPage<PipingDefaultParameterData>>;
    pluginPipings_get(
        params: Record<string, unknown>,
    ): Promise<PluginPipingItem[]>;
    pluginPipingsPage_get(
        params: Record<string, unknown>,
    ): Promise<ListPage<PluginPipingItem>>;
}

Index

Properties

Methods

defaultParametersPage_get pluginPipings_get pluginPipingsPage_get

Properties

data

data: PipelineRecord | null

The pipeline's wire payload, or null when absent.

Methods

defaultParametersPage_get

defaultParametersPage_get(
params: Record<string, unknown>,
): Promise<ListPage<PipingDefaultParameterData>>
Reads one page of the stored piping default parameters.
Parameters
- params: Record<string, unknown>
  Page window (limit, offset).
Returns Promise<ListPage<PipingDefaultParameterData>>
The page of stored defaults.
- Defined in packages/cumin/src/chrisapi/contract.ts:654

pluginPipings_get

pluginPipings_get(params: Record<string, unknown>): Promise<PluginPipingItem[]>
Reads the pipeline's plugin pipings as items (plugin link preserved).
Parameters
- params: Record<string, unknown>
  Page window (limit, offset).
Returns Promise<PluginPipingItem[]>
The piping items of that page.
- Defined in packages/cumin/src/chrisapi/contract.ts:638

pluginPipingsPage_get

pluginPipingsPage_get(
params: Record<string, unknown>,
): Promise<ListPage<PluginPipingItem>>
Reads one page of the pipeline's plugin pipings with its pagination signals intact, so a paginated walk can advance correctly even when a served row carries no data and is dropped from the items.
Parameters
- params: Record<string, unknown>
  Page window (limit, offset).
Returns Promise<ListPage<PluginPipingItem>>
The typed page; fetchedCount reflects rows served.
- Defined in packages/cumin/src/chrisapi/contract.ts:647