Vue OpenAPI Query Documentation
    Preparing search index...

    Function useEndpointQuery

    • Execute a type-safe query (GET/HEAD/OPTIONS) with automatic caching.

      This is a low-level primitive — in normal usage it is called by the generated per-operation useQuery 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: QueryOptions<TResponse, TQueryParams>

        Query options (enabled, staleTime, queryParams, onLoad, etc.)

      Returns QueryReturn<TResponse, TPathParams>