Skip to content

Function: useOnQuery()

ts
function useOnQuery<R, P, T>(host: ReactiveElement, options: UseOnQueryOptions<R, P, T>): OnQueryController<R, P, T>;

Defined in: src/wirestate-lit/queries/use-on-query.ts:48

Registers a query handler for the host element's lifetime.

Type Parameters

Type ParameterDefault type
Runknown
Punknown
T extends QueryTypeQueryType

Parameters

ParameterTypeDescription
hostReactiveElementHost element.
optionsUseOnQueryOptions<R, P, T>Query handling options.

Returns

OnQueryController<R, P, T>

Query controller.

Remarks

Registers when the host connects, unregisters when it disconnects, and re-registers when the nearest container context changes. Query handlers are stack-based on the active query bus.

Example

typescript
class MyElement extends LitElement {
  private getUserController = useOnQuery(this, {
    type: "GET_USER",
    handler: (payload) => ({ name: "Alice" }),
  });
}