Defined in: vue-query/src/queryClient.ts:44
Vue-aware subclass of @tanstack/query-core's QueryClient. Methods that accept options (such as CancelOptions or InvalidateOptions) or filters (such as the QueryFilters accepted by invalidateQueries) also accept a MaybeRefDeep version of it, so you can pass refs directly without unwrapping them yourself — e.g. queryClient.invalidateQueries({ queryKey: ['post', myRef] }). Install one on your app with VueQueryPlugin, or retrieve it with useQueryClient.
QueryClient
new QueryClient(config): QueryClient;Defined in: vue-query/src/queryClient.ts:45
QueryClientConfig = {}
QueryClient
QC.constructoroptional isRestoring: Ref<boolean, boolean>;Defined in: vue-query/src/queryClient.ts:58
true while a clientPersister passed to VueQueryPlugin is restoring the cache. Queries don't fetch while this is true. Defaults to false if no persister is configured.
cancelQueries<TTaggedQueryKey>(filters?, options?): Promise<void>;Defined in: vue-query/src/queryClient.ts:185
TTaggedQueryKey extends readonly unknown[] = readonly unknown[]
QueryFilters<TTaggedQueryKey>
MaybeRefDeep<CancelOptions>
Promise<void>
QC.cancelQueriesensureQueryData<TQueryFnData, TError, TData, TQueryKey>(options): Promise<TData>;Defined in: vue-query/src/queryClient.ts:83
TQueryFnData
TError = Error
TData = TQueryFnData
TQueryKey extends readonly unknown[] = readonly unknown[]
EnsureQueryDataOptions<TQueryFnData, TError, TData, TQueryKey>
Promise<TData>
Use queryClient.query({ ...options, staleTime: 'static' }) instead. This method will be removed in the next major version.
QC.ensureQueryDataensureQueryData<TQueryFnData, TError, TData, TQueryKey>(options): Promise<TData>;Defined in: vue-query/src/queryClient.ts:91
TQueryFnData
TError = Error
TData = TQueryFnData
TQueryKey extends readonly unknown[] = readonly unknown[]
MaybeRefDeep<EnsureQueryDataOptions<TQueryFnData, TError, TData, TQueryKey, never>>
Promise<TData>
Use queryClient.query({ ...options, staleTime: 'static' }) instead. This method will be removed in the next major version.
QC.ensureQueryDatafetchInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): Promise<InfiniteData<TData, TPageParam>>;Defined in: vue-query/src/queryClient.ts:464
TQueryFnData = unknown
TError = Error
TData = TQueryFnData
TQueryKey extends readonly unknown[] = readonly unknown[]
TPageParam = unknown
FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
Promise<InfiniteData<TData, TPageParam>>
Use queryClient.infiniteQuery(options) instead. This method will be removed in the next major version.
QC.fetchInfiniteQueryfetchInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): Promise<InfiniteData<TData, TPageParam>>;Defined in: vue-query/src/queryClient.ts:479
TQueryFnData
TError = Error
TData = TQueryFnData
TQueryKey extends readonly unknown[] = readonly unknown[]
TPageParam = unknown
MaybeRefDeep<FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>>
Promise<InfiniteData<TData, TPageParam>>
Use queryClient.infiniteQuery(options) instead. This method will be removed in the next major version.
QC.fetchInfiniteQueryfetchQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): Promise<TData>;Defined in: vue-query/src/queryClient.ts:313
TQueryFnData
TError = Error
TData = TQueryFnData
TQueryKey extends readonly unknown[] = readonly unknown[]
TPageParam = never
FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
Promise<TData>
Use queryClient.query(options) instead. This method will be removed in the next major version.
QC.fetchQueryfetchQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): Promise<TData>;Defined in: vue-query/src/queryClient.ts:328
TQueryFnData
TError = Error
TData = TQueryFnData
TQueryKey extends readonly unknown[] = readonly unknown[]
TPageParam = never
MaybeRefDeep<FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>> | () => FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
Promise<TData>
Use queryClient.query(options) instead. This method will be removed in the next major version.
QC.fetchQuerygetMutationDefaults(mutationKey): MutationObserverOptions<any, any, any, any>;Defined in: vue-query/src/queryClient.ts:612
MaybeRefDeep<readonly unknown[]>
MutationObserverOptions<any, any, any, any>
QC.getMutationDefaultsgetQueriesData<TData>(filters): [readonly unknown[], TData | undefined][];Defined in: vue-query/src/queryClient.ts:114
TData = unknown
MaybeRefDeep<QueryFilters<readonly unknown[]>>
[readonly unknown[], TData | undefined][]
QC.getQueriesDatagetQueryData<TData, TTaggedQueryKey>(queryKey): InferDataFromTag<TData, TTaggedQueryKey> | undefined;Defined in: vue-query/src/queryClient.ts:68
Imperative (non-reactive) way to retrieve data for a QueryKey. Should only be used in callbacks or functions where reading the latest data is necessary, e.g. for optimistic updates.
Hint: Do not use this function inside a component, because it won't receive updates. Use useQuery to create a QueryObserver that subscribes to changes.
TData = unknown
TTaggedQueryKey extends readonly unknown[] = readonly unknown[]
TTaggedQueryKey
InferDataFromTag<TData, TTaggedQueryKey> | undefined
QC.getQueryDatagetQueryData<TData>(queryKey): TData | undefined;Defined in: vue-query/src/queryClient.ts:71
TData = unknown
MaybeRefDeep<readonly unknown[]>
TData | undefined
QC.getQueryDatagetQueryDefaults(queryKey): OmitKeyof<QueryObserverOptions<any, any, any, any, any>, "queryKey">;Defined in: vue-query/src/queryClient.ts:589
MaybeRefDeep<readonly unknown[]>
OmitKeyof<QueryObserverOptions<any, any, any, any, any>, "queryKey">
QC.getQueryDefaultsgetQueryState<TData, TError>(queryKey): QueryState<TData, TError> | undefined;Defined in: vue-query/src/queryClient.ts:161
TData = unknown
TError = Error
MaybeRefDeep<readonly unknown[]>
QueryState<TData, TError> | undefined
QC.getQueryStateinfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): Promise<TData[] extends InfiniteData<TQueryFnData, unknown>[] ? InfiniteData<TQueryFnData, TPageParam> : TData>;Defined in: vue-query/src/queryClient.ts:397
TQueryFnData = unknown
TError = Error
TData = InfiniteData<TQueryFnData, unknown>
TQueryKey extends readonly unknown[] = readonly unknown[]
TPageParam = unknown
InfiniteQueryExecuteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
Promise<TData[] extends InfiniteData<TQueryFnData, unknown>[] ? InfiniteData<TQueryFnData, TPageParam> : TData>
QC.infiniteQueryinfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): Promise<TData[] extends InfiniteData<TQueryFnData, unknown>[] ? InfiniteData<TQueryFnData, TPageParam> : TData>;Defined in: vue-query/src/queryClient.ts:416
TQueryFnData = unknown
TError = Error
TData = InfiniteData<TQueryFnData, unknown>
TQueryKey extends readonly unknown[] = readonly unknown[]
TPageParam = unknown
MaybeRefDeep<InfiniteQueryExecuteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>>
Promise<TData[] extends InfiniteData<TQueryFnData, unknown>[] ? InfiniteData<TQueryFnData, TPageParam> : TData>
QC.infiniteQueryinvalidateQueries<TTaggedQueryKey>(filters?, options?): Promise<void>;Defined in: vue-query/src/queryClient.ts:196
TTaggedQueryKey extends readonly unknown[] = readonly unknown[]
InvalidateQueryFilters<TTaggedQueryKey> | () => InvalidateQueryFilters<TTaggedQueryKey>
MaybeRefDeep<InvalidateOptions>
Promise<void>
QC.invalidateQueriesisFetching(filters): number;Defined in: vue-query/src/queryClient.ts:60
MaybeRefDeep<QueryFilters<readonly unknown[]>> = {}
number
QC.isFetchingisMutating(filters): number;Defined in: vue-query/src/queryClient.ts:64
MaybeRefDeep<MutationFilters<unknown, Error, unknown, unknown>> = {}
number
QC.isMutatingprefetchInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): Promise<void>;Defined in: vue-query/src/queryClient.ts:519
TQueryFnData
TError = Error
TData = TQueryFnData
TQueryKey extends readonly unknown[] = readonly unknown[]
TPageParam = unknown
FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
Promise<void>
use void queryClient.infiniteQuery(options) instead. You can swallow errors with .catch(noop). This method will be removed in the next major version.
QC.prefetchInfiniteQueryprefetchInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): Promise<void>;Defined in: vue-query/src/queryClient.ts:534
TQueryFnData
TError = Error
TData = TQueryFnData
TQueryKey extends readonly unknown[] = readonly unknown[]
TPageParam = unknown
MaybeRefDeep<FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>>
Promise<void>
use void queryClient.infiniteQuery(options) instead. You can swallow errors with .catch(noop). This method will be removed in the next major version.
QC.prefetchInfiniteQueryprefetchQuery<TQueryFnData, TError, TData, TQueryKey>(options): Promise<void>;Defined in: vue-query/src/queryClient.ts:364
TQueryFnData = unknown
TError = Error
TData = TQueryFnData
TQueryKey extends readonly unknown[] = readonly unknown[]
FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>
Promise<void>
Use queryClient.query(options) instead. You can swallow errors with .catch(noop). This method will be removed in the next major version.
QC.prefetchQueryprefetchQuery<TQueryFnData, TError, TData, TQueryKey>(options): Promise<void>;Defined in: vue-query/src/queryClient.ts:372
TQueryFnData = unknown
TError = Error
TData = TQueryFnData
TQueryKey extends readonly unknown[] = readonly unknown[]
MaybeRefDeep<FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, never>>
Promise<void>
Use queryClient.query(options) instead. You can swallow errors with .catch(noop). This method will be removed in the next major version.
QC.prefetchQueryquery<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>(options): Promise<TData>;Defined in: vue-query/src/queryClient.ts:252
TQueryFnData
TError = Error
TData = TQueryFnData
TQueryData = TQueryFnData
TQueryKey extends readonly unknown[] = readonly unknown[]
TPageParam = never
QueryExecuteOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>
Promise<TData>
QC.queryquery<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>(options): Promise<TData>;Defined in: vue-query/src/queryClient.ts:269
TQueryFnData
TError = Error
TData = TQueryFnData
TQueryData = TQueryFnData
TQueryKey extends readonly unknown[] = readonly unknown[]
TPageParam = never
MaybeRefDeep<QueryExecuteOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>>
Promise<TData>
QC.queryrefetchQueries<TTaggedQueryKey>(filters?, options?): Promise<void>;Defined in: vue-query/src/queryClient.ts:236
TTaggedQueryKey extends readonly unknown[] = readonly unknown[]
RefetchQueryFilters<TTaggedQueryKey>
MaybeRefDeep<RefetchOptions>
Promise<void>
QC.refetchQueriesremoveQueries<TTaggedQueryKey>(filters?): void;Defined in: vue-query/src/queryClient.ts:167
TTaggedQueryKey extends readonly unknown[] = readonly unknown[]
QueryFilters<TTaggedQueryKey>
void
QC.removeQueriesresetQueries<TTaggedQueryKey>(filters?, options?): Promise<void>;Defined in: vue-query/src/queryClient.ts:174
TTaggedQueryKey extends readonly unknown[] = readonly unknown[]
QueryFilters<TTaggedQueryKey>
MaybeRefDeep<ResetOptions>
Promise<void>
QC.resetQueriessetDefaultOptions(options): void;Defined in: vue-query/src/queryClient.ts:571
MaybeRefDeep<DefaultOptions<Error>>
void
QC.setDefaultOptionssetMutationDefaults<TData, TError, TVariables, TOnMutateResult>(mutationKey, options): void;Defined in: vue-query/src/queryClient.ts:595
TData = unknown
TError = Error
TVariables = void
TOnMutateResult = unknown
MaybeRefDeep<readonly unknown[]>
MaybeRefDeep<MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>>
void
QC.setMutationDefaultssetQueriesData<TData>(
filters,
updater,
options): [readonly unknown[], TData | undefined][];Defined in: vue-query/src/queryClient.ts:149
TData
MaybeRefDeep<QueryFilters<readonly unknown[]>>
Updater<TData | undefined, TData | undefined>
MaybeRefDeep<SetDataOptions> = {}
[readonly unknown[], TData | undefined][]
QC.setQueriesDatasetQueryData<TQueryFnData, TTaggedQueryKey, TInferredQueryFnData>(
queryKey,
updater,
options?): NoInfer<TInferredQueryFnData> | undefined;Defined in: vue-query/src/queryClient.ts:120
TQueryFnData = unknown
TTaggedQueryKey extends readonly unknown[] = readonly unknown[]
TInferredQueryFnData = InferDataFromTag<TQueryFnData, TTaggedQueryKey>
TTaggedQueryKey
Updater<NoInfer<TInferredQueryFnData> | undefined, NoInfer<TInferredQueryFnData> | undefined>
MaybeRefDeep<SetDataOptions>
NoInfer<TInferredQueryFnData> | undefined
QC.setQueryDatasetQueryData<TQueryFnData, TData>(
queryKey,
updater,
options?): NoInfer<TData> | undefined;Defined in: vue-query/src/queryClient.ts:132
TQueryFnData
TData = NoUnknown<TQueryFnData>
MaybeRefDeep<readonly unknown[]>
Updater<NoInfer<TData> | undefined, NoInfer<TData> | undefined>
MaybeRefDeep<SetDataOptions>
NoInfer<TData> | undefined
QC.setQueryDatasetQueryDefaults<TQueryFnData, TError, TData, TQueryData>(queryKey, options): void;Defined in: vue-query/src/queryClient.ts:575
TQueryFnData = unknown
TError = Error
TData = TQueryFnData
TQueryData = TQueryFnData
MaybeRefDeep<readonly unknown[]>
MaybeRefDeep<Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryData>, "queryKey">>
void
QC.setQueryDefaults