Function useEndpointLazyQuery

useEndpointLazyQuery<
    TResponse,
    TPathParams extends Record<string, unknown> = Record<string, never>,
    TQueryParams extends Record<string, unknown> = Record<string, never>,
>(
    config: EndpointConfig,
    pathParams?: MaybeRefOrGetter<
        Record<string, string | number | undefined>
        | null
        | undefined,
    >,
    options?: Omit<
        QueryOptions<TResponse, TQueryParams>,
        "enabled" | "onLoad" | "queryParams",
    >,
): LazyQueryReturn<TResponse, TPathParams, TQueryParams>
Execute a type-safe lazy query (GET/HEAD/OPTIONS) with imperative execution.

Lazy queries do not auto-execute. The fetch() method must be called explicitly with query parameters. Results are cached and shared with useQuery for the same operation+params.

This is a low-level primitive — in normal usage it is called by the generated per-operation useLazyQuery wrappers in api-client.ts, not directly.
Type Parameters
- TResponse
  The response data type
- TPathParams extends Record<string, unknown> = Record<string, never>
  The path parameters type (concrete, required values)
- TQueryParams extends Record<string, unknown> = Record<string, never>
  The query parameters type
Parameters
- config: EndpointConfig
  Endpoint config: axios instance, queryClient, path, method, listPath
- OptionalpathParams: MaybeRefOrGetter<Record<string, string | number | undefined> | null | undefined>
  Path parameters (reactive). Pass undefined for operations without path params.
- Optionaloptions: Omit<
  QueryOptions<TResponse, TQueryParams>,
  "enabled" | "onLoad" | "queryParams",
  >
  Query options (staleTime, errorHandler, axiosOptions — but NOT queryParams/onLoad/enabled)
Returns LazyQueryReturn<TResponse, TPathParams, TQueryParams>
- Defined in openapi-query.ts:275

Function useEndpointLazyQuery

Type Parameters

Parameters

Returns LazyQueryReturn<TResponse, TPathParams, TQueryParams>

Settings