Constructors
constructor
- new QueryClient(config?): QueryClient
-
Methods
cancelQueries
- cancelQueries(filters?, options?): Promise<void>
-
Returns Promise<void>
- cancelQueries(queryKey?, filters?, options?): Promise<void>
-
Returns Promise<void>
clear
- clear(): void
-
Returns void
defaultMutationOptions
- defaultMutationOptions<T>(options?): T
-
Returns T
defaultQueryOptions
- defaultQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>(options?): DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
-
Type Parameters
-
TQueryFnData
-
TError
-
TData
-
TQueryData
-
TQueryKey extends readonly unknown[]
Returns DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
ensureQueryData
- ensureQueryData<TQueryFnData, TError, TData, TQueryKey>(options): Promise<TData>
-
Type Parameters
-
TQueryFnData = unknown
-
TError = unknown
-
TData = TQueryFnData
-
TQueryKey extends readonly unknown[] = QueryKey
Returns Promise<TData>
- ensureQueryData<TQueryFnData, TError, TData, TQueryKey>(queryKey, options?): Promise<TData>
-
Type Parameters
-
TQueryFnData = unknown
-
TError = unknown
-
TData = TQueryFnData
-
TQueryKey extends readonly unknown[] = QueryKey
Parameters
-
queryKey: TQueryKey
-
Optional options: Omit<FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>, "queryKey">
Returns Promise<TData>
- ensureQueryData<TQueryFnData, TError, TData, TQueryKey>(queryKey, queryFn, options?): Promise<TData>
-
Type Parameters
-
TQueryFnData = unknown
-
TError = unknown
-
TData = TQueryFnData
-
TQueryKey extends readonly unknown[] = QueryKey
Parameters
-
queryKey: TQueryKey
-
queryFn: QueryFunction<TQueryFnData, TQueryKey>
-
Optional options: Omit<FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>, "queryFn" | "queryKey">
Returns Promise<TData>
fetchInfiniteQuery
- fetchInfiniteQuery<TQueryFnData, TError, TData, TQueryKey>(options): Promise<InfiniteData<TData>>
-
Type Parameters
-
TQueryFnData = unknown
-
TError = unknown
-
TData = TQueryFnData
-
TQueryKey extends readonly unknown[] = QueryKey
- fetchInfiniteQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey, options?): Promise<InfiniteData<TData>>
-
Type Parameters
-
TQueryFnData = unknown
-
TError = unknown
-
TData = TQueryFnData
-
TQueryKey extends readonly unknown[] = QueryKey
- fetchInfiniteQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey, queryFn, options?): Promise<InfiniteData<TData>>
-
Type Parameters
-
TQueryFnData = unknown
-
TError = unknown
-
TData = TQueryFnData
-
TQueryKey extends readonly unknown[] = QueryKey
fetchQuery
- fetchQuery<TQueryFnData, TError, TData, TQueryKey>(options): Promise<TData>
-
Type Parameters
-
TQueryFnData = unknown
-
TError = unknown
-
TData = TQueryFnData
-
TQueryKey extends readonly unknown[] = QueryKey
Returns Promise<TData>
- fetchQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey, options?): Promise<TData>
-
Type Parameters
-
TQueryFnData = unknown
-
TError = unknown
-
TData = TQueryFnData
-
TQueryKey extends readonly unknown[] = QueryKey
Parameters
-
queryKey: TQueryKey
-
Optional options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>
Returns Promise<TData>
- fetchQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey, queryFn, options?): Promise<TData>
-
Type Parameters
-
TQueryFnData = unknown
-
TError = unknown
-
TData = TQueryFnData
-
TQueryKey extends readonly unknown[] = QueryKey
Returns Promise<TData>
getDefaultOptions
- getDefaultOptions(): DefaultOptions<unknown>
-
getLogger
- getLogger(): Logger
-
getMutationCache
- getMutationCache(): MutationCache
-
getMutationDefaults
- getMutationDefaults(mutationKey?): undefined | MutationObserverOptions<any, any, any, any>
-
getQueriesData
- getQueriesData<TQueryFnData>(queryKey): [QueryKey, undefined | TQueryFnData][]
-
Returns [QueryKey, undefined | TQueryFnData][]
- getQueriesData<TQueryFnData>(filters): [QueryKey, undefined | TQueryFnData][]
-
Returns [QueryKey, undefined | TQueryFnData][]
getQueryCache
- getQueryCache(): QueryCache
-
getQueryData
- getQueryData<TQueryFnData>(queryKey, filters?): undefined | TQueryFnData
-
Returns undefined | TQueryFnData
getQueryDefaults
- getQueryDefaults(queryKey?): undefined | QueryObserverOptions<any, any, any, any, any>
-
Returns undefined | QueryObserverOptions<any, any, any, any, any>
getQueryState
- getQueryState<TQueryFnData, TError>(queryKey, filters?): undefined | QueryState<TQueryFnData, TError>
-
Type Parameters
-
TQueryFnData = unknown
-
TError = undefined
Returns undefined | QueryState<TQueryFnData, TError>
invalidateQueries
- invalidateQueries<TPageData>(filters?, options?): Promise<void>
-
Returns Promise<void>
- invalidateQueries<TPageData>(queryKey?, filters?, options?): Promise<void>
-
Returns Promise<void>
isFetching
- isFetching(filters?): number
-
Returns number
- isFetching(queryKey?, filters?): number
-
Returns number
isMutating
- isMutating(filters?): number
-
Returns number
mount
- mount(): void
-
Returns void
prefetchInfiniteQuery
- prefetchInfiniteQuery<TQueryFnData, TError, TData, TQueryKey>(options): Promise<void>
-
Type Parameters
-
TQueryFnData = unknown
-
TError = unknown
-
TData = TQueryFnData
-
TQueryKey extends readonly unknown[] = QueryKey
Returns Promise<void>
- prefetchInfiniteQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey, options?): Promise<void>
-
Type Parameters
-
TQueryFnData = unknown
-
TError = unknown
-
TData = TQueryFnData
-
TQueryKey extends readonly unknown[] = QueryKey
Returns Promise<void>
- prefetchInfiniteQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey, queryFn, options?): Promise<void>
-
Type Parameters
-
TQueryFnData = unknown
-
TError = unknown
-
TData = TQueryFnData
-
TQueryKey extends readonly unknown[] = QueryKey
Returns Promise<void>
prefetchQuery
- prefetchQuery<TQueryFnData, TError, TData, TQueryKey>(options): Promise<void>
-
Type Parameters
-
TQueryFnData = unknown
-
TError = unknown
-
TData = TQueryFnData
-
TQueryKey extends readonly unknown[] = QueryKey
Returns Promise<void>
- prefetchQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey, options?): Promise<void>
-
Type Parameters
-
TQueryFnData = unknown
-
TError = unknown
-
TData = TQueryFnData
-
TQueryKey extends readonly unknown[] = QueryKey
Parameters
-
queryKey: TQueryKey
-
Optional options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>
Returns Promise<void>
- prefetchQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey, queryFn, options?): Promise<void>
-
Type Parameters
-
TQueryFnData = unknown
-
TError = unknown
-
TData = TQueryFnData
-
TQueryKey extends readonly unknown[] = QueryKey
Returns Promise<void>
refetchQueries
- refetchQueries<TPageData>(filters?, options?): Promise<void>
-
Returns Promise<void>
- refetchQueries<TPageData>(queryKey?, filters?, options?): Promise<void>
-
Returns Promise<void>
removeQueries
- removeQueries(filters?): void
-
Returns void
- removeQueries(queryKey?, filters?): void
-
Returns void
resetQueries
- resetQueries<TPageData>(filters?, options?): Promise<void>
-
Returns Promise<void>
- resetQueries<TPageData>(queryKey?, filters?, options?): Promise<void>
-
Returns Promise<void>
resumePausedMutations
- resumePausedMutations(): Promise<unknown>
-
Returns Promise<unknown>
setDefaultOptions
- setDefaultOptions(options): void
-
Returns void
setMutationDefaults
- setMutationDefaults(mutationKey, options): void
-
Returns void
setQueriesData
- setQueriesData<TQueryFnData>(queryKey, updater, options?): [QueryKey, undefined | TQueryFnData][]
-
Parameters
-
-
updater: Updater<undefined | TQueryFnData, undefined | TQueryFnData>
-
Returns [QueryKey, undefined | TQueryFnData][]
- setQueriesData<TQueryFnData>(filters, updater, options?): [QueryKey, undefined | TQueryFnData][]
-
Parameters
-
-
updater: Updater<undefined | TQueryFnData, undefined | TQueryFnData>
-
Returns [QueryKey, undefined | TQueryFnData][]
setQueryData
- setQueryData<TQueryFnData>(queryKey, updater, options?): undefined | TQueryFnData
-
Parameters
-
-
updater: Updater<undefined | TQueryFnData, undefined | TQueryFnData>
-
Returns undefined | TQueryFnData
setQueryDefaults
- setQueryDefaults(queryKey, options): void
-
Returns void
unmount
- unmount(): void
-
Returns void
Properties
Private defaultOptions
defaultOptions: any
Private logger
logger: any
Private mountCount
mountCount: any
Private mutationCache
mutationCache: any
Private mutationDefaults
mutationDefaults: any
Private queryCache
queryCache: any
Private queryDefaults
queryDefaults: any
Private Optional unsubscribeFocus
unsubscribeFocus?: any
Private Optional unsubscribeOnline
unsubscribeOnline?: any