Skip to content

Function: useOnQuery()

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

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

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

Type Parameters

Type ParameterDefault type
Dunknown
Runknown

Parameters

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

Returns

OnQueryController<D, R>

Query controller.

Example

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