Vue OpenAPI Query Documentation
    Preparing search index...

    Type Alias QueryOptions<TResponse, TQueryParams>

    QueryOptions: Omit<
        BaseQueryOptions<TResponse, TQueryParams>,
        "queryKey" | "queryFn" | "enabled",
    > & {
        enabled?: ReactiveOr<boolean>;
        onLoad?: (data: TResponse) => void;
        axiosOptions?: AxiosRequestConfigExtended;
        errorHandler?: (
            error: AxiosError,
        ) => TResponse | void | Promise<TResponse | void>;
        queryParams?: ReactiveOr<TQueryParams>;
    }

    Options for useQuery composable. Accepts all TanStack Query options plus:

    • enabled: reactive boolean
    • queryParams: reactive query string parameters
    • onLoad: callback when data loads for the first time
    • errorHandler: custom error handler
    • axiosOptions: additional axios config

    Type Parameters

    • TResponse

      The response data type for this operation

    • TQueryParams extends Record<string, unknown> = Record<string, never>

      The query parameters type for this operation

    Settings

    Member Visibility