Interface PluginHandle

Typed handle over one plugin detail resource (metadata surfaces only).

interface PluginHandle {
    computeResourcesPage_get(
        params: Record<string, unknown>,
    ): Promise<ListPage<ComputeResourceData>>;
    parametersPage_get(
        params: Record<string, unknown>,
    ): Promise<ListPage<PluginParameterData>>;
}

Index

Methods

computeResourcesPage_get parametersPage_get

Methods

computeResourcesPage_get

computeResourcesPage_get(
params: Record<string, unknown>,
): Promise<ListPage<ComputeResourceData>>
Reads one page of the plugin's registered compute resources.
Parameters
- params: Record<string, unknown>
  Page window (limit, offset).
Returns Promise<ListPage<ComputeResourceData>>
The page of compute-resource rows.
- Defined in packages/cumin/src/chrisapi/contract.ts:607

parametersPage_get

parametersPage_get(
params: Record<string, unknown>,
): Promise<ListPage<PluginParameterData>>
Reads one page of the plugin's declared parameters.
Parameters
- params: Record<string, unknown>
  Page window (limit, offset).
Returns Promise<ListPage<PluginParameterData>>
The page of parameter definitions.
- Defined in packages/cumin/src/chrisapi/contract.ts:600