Interface RendererMountRequest<T, TOptions>

Request passed to an injected renderer adapter.

The adapter may ask for a query plan only when its existing strategy needs materialized features. Planning is memoized and performs no result I/O.

interface RendererMountRequest<T = Record<string, unknown>, TOptions = unknown> {
    execution: ExecuteQueryPlanOptions;
    ownership: RendererOwnership;
    queryIntent: "default" | "explicit";
    queryPlan?: QueryExecutionPlanV1;
    rendererOptions?: TOptions;
    signal: AbortSignal;
    source: Source<T>;
    style?: Readonly<Record<string, unknown>> | "auto";
    planQuery(): Promise<QueryExecutionPlanV1>;
}

Type Parameters

T = Record<string, unknown>
TOptions = unknown

Index

Properties

execution ownership queryIntent queryPlan? rendererOptions? signal source style?

Methods

Properties

`Readonly`execution

execution: ExecuteQueryPlanOptions

`Readonly`ownership

ownership: RendererOwnership

`Readonly`queryIntent

queryIntent: "default" | "explicit"

Distinguishes the kernel's safe default query from caller-authored filtering intent.

`Optional` `Readonly`queryPlan

queryPlan?: QueryExecutionPlanV1

`Optional` `Readonly`rendererOptions

rendererOptions?: TOptions

`Readonly`signal

signal: AbortSignal

`Readonly`source

source: Source<T>

`Optional` `Readonly`style

style?: Readonly<Record<string, unknown>> | "auto"

Methods

planQuery

planQuery(): Promise<QueryExecutionPlanV1>
Returns Promise<QueryExecutionPlanV1>
- Defined in work/honua-sdk-js/honua-sdk-js/src/kernel/renderer.ts:46