QueryClient

class QueryClient {

constructor(config?: QueryClientConfig);

private defaultOptions;

private logger;

private mountCount;

private mutationCache;

private mutationDefaults;

private queryCache;

private queryDefaults;

private unsubscribeFocus?;

private unsubscribeOnline?;

cancelQueries(filters?: QueryFilters, options?: CancelOptions): Promise<void>;

cancelQueries(

queryKey?: QueryKey,

filters?: QueryFilters,

options?: CancelOptions,

): Promise<void>;

clear(): void;

defaultMutationOptions<T extends MutationOptions<any, any, any, any>>(options?: T): T;

defaultQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey extends QueryKey>(options?: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> | DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>;

ensureQueryData<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: WithRequired<FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>, "queryKey">): Promise<TData>;

ensureQueryData<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, options?: Omit<FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>, "queryKey">): Promise<TData>;

ensureQueryData<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(

queryKey: TQueryKey,

queryFn: QueryFunction<TQueryFnData, TQueryKey>,

options?: Omit<FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>, "queryKey" | "queryFn">,

): Promise<TData>;

fetchInfiniteQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<InfiniteData<TData>>;

fetchInfiniteQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, options?: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<InfiniteData<TData>>;

fetchInfiniteQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(

queryKey: TQueryKey,

queryFn: QueryFunction<TQueryFnData, TQueryKey>,

options?: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,

): Promise<InfiniteData<TData>>;

fetchQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<TData>;

fetchQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, options?: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<TData>;

fetchQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(

queryKey: TQueryKey,

queryFn: QueryFunction<TQueryFnData, TQueryKey>,

options?: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,

): Promise<TData>;

getDefaultOptions(): DefaultOptions;

getLogger(): Logger;

getMutationCache(): MutationCache;

getMutationDefaults(mutationKey?: MutationKey): MutationObserverOptions<any, any, any, any> | undefined;

getQueriesData<TQueryFnData = unknown>(queryKey: QueryKey): [QueryKey, TQueryFnData | undefined][];

getQueriesData<TQueryFnData = unknown>(filters: QueryFilters): [QueryKey, TQueryFnData | undefined][];

getQueryCache(): QueryCache;

getQueryData<TQueryFnData = unknown>(queryKey: QueryKey, filters?: QueryFilters): TQueryFnData | undefined;

getQueryDefaults(queryKey?: QueryKey): QueryObserverOptions<any, any, any, any, any> | undefined;

getQueryState<TQueryFnData = unknown, TError = undefined>(queryKey: QueryKey, filters?: QueryFilters): QueryState<TQueryFnData, TError> | undefined;

invalidateQueries<TPageData = unknown>(filters?: InvalidateQueryFilters<TPageData>, options?: InvalidateOptions): Promise<void>;

invalidateQueries<TPageData = unknown>(

queryKey?: QueryKey,

filters?: InvalidateQueryFilters<TPageData>,

options?: InvalidateOptions,

): Promise<void>;

isFetching(filters?: QueryFilters): number;

isFetching(queryKey?: QueryKey, filters?: QueryFilters): number;

isMutating(filters?: MutationFilters): number;

mount(): void;

prefetchInfiniteQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>;

prefetchInfiniteQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, options?: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>;

prefetchInfiniteQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(

queryKey: TQueryKey,

queryFn: QueryFunction<TQueryFnData, TQueryKey>,

options?: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey>,

): Promise<void>;

prefetchQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>;

prefetchQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, options?: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>): Promise<void>;

prefetchQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(

queryKey: TQueryKey,

queryFn: QueryFunction<TQueryFnData, TQueryKey>,

options?: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,

): Promise<void>;

refetchQueries<TPageData = unknown>(filters?: RefetchQueryFilters<TPageData>, options?: RefetchOptions): Promise<void>;

refetchQueries<TPageData = unknown>(

queryKey?: QueryKey,

filters?: RefetchQueryFilters<TPageData>,

options?: RefetchOptions,

): Promise<void>;

removeQueries(filters?: QueryFilters): void;

removeQueries(queryKey?: QueryKey, filters?: QueryFilters): void;

resetQueries<TPageData = unknown>(filters?: ResetQueryFilters<TPageData>, options?: ResetOptions): Promise<void>;

resetQueries<TPageData = unknown>(

queryKey?: QueryKey,

filters?: ResetQueryFilters<TPageData>,

options?: ResetOptions,

): Promise<void>;

resumePausedMutations(): Promise<unknown>;

setDefaultOptions(options: DefaultOptions): void;

setMutationDefaults(mutationKey: MutationKey, options: MutationObserverOptions<any, any, any, any>): void;

setQueriesData<TQueryFnData>(

queryKey: QueryKey,

updater: Updater<TQueryFnData | undefined, TQueryFnData | undefined>,

options?: SetDataOptions,

): [QueryKey, TQueryFnData | undefined][];

setQueriesData<TQueryFnData>(

filters: QueryFilters,

updater: Updater<TQueryFnData | undefined, TQueryFnData | undefined>,

options?: SetDataOptions,

): [QueryKey, TQueryFnData | undefined][];

setQueryData<TQueryFnData>(

queryKey: QueryKey,

updater: Updater<TQueryFnData | undefined, TQueryFnData | undefined>,

options?: SetDataOptions,

): TQueryFnData | undefined;

setQueryDefaults(queryKey: QueryKey, options: QueryObserverOptions<unknown, any, any, any>): void;

unmount(): void;

}

§Constructors

new QueryClient(config?: QueryClientConfig)

QueryClient

§Constructors

§Properties

§Methods