Class QueryClient

Constructors

constructor

Properties

defaultOptions logger mountCount mutationCache mutationDefaults queryCache queryDefaults unsubscribeFocus? unsubscribeOnline?

Methods

cancelQueries clear defaultMutationOptions defaultQueryOptions ensureQueryData fetchInfiniteQuery fetchQuery getDefaultOptions getLogger getMutationCache getMutationDefaults getQueriesData getQueryCache getQueryData getQueryDefaults getQueryState invalidateQueries isFetching isMutating mount prefetchInfiniteQuery prefetchQuery refetchQueries removeQueries resetQueries resumePausedMutations setDefaultOptions setMutationDefaults setQueriesData setQueryData setQueryDefaults unmount

Constructors

constructor

  • new QueryClient(config?): QueryClient

  • Parameters

    Returns QueryClient

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

Methods

cancelQueries

  • cancelQueries(filters?, options?): Promise<void>

  • Parameters

    Returns Promise<void>

  • cancelQueries(queryKey?, filters?, options?): Promise<void>

  • Parameters

    Returns Promise<void>

clear

  • clear(): void

  • Returns void

defaultMutationOptions

  • defaultMutationOptions<T>(options?): T

  • Type Parameters

    Parameters

    • Optional 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 QueryKey

    Parameters

    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 QueryKey = QueryKey

    Parameters

    Returns Promise<TData>

  • ensureQueryData<TQueryFnData, TError, TData, TQueryKey>(queryKey, options?): Promise<TData>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = 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 QueryKey = 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 QueryKey = QueryKey

    Parameters

    Returns Promise<InfiniteData<TData>>

  • fetchInfiniteQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey, options?): Promise<InfiniteData<TData>>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

    Returns Promise<InfiniteData<TData>>

  • fetchInfiniteQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey, queryFn, options?): Promise<InfiniteData<TData>>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

    Returns Promise<InfiniteData<TData>>

fetchQuery

  • fetchQuery<TQueryFnData, TError, TData, TQueryKey>(options): Promise<TData>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

    Returns Promise<TData>

  • fetchQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey, options?): Promise<TData>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = 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 QueryKey = QueryKey

    Parameters

    Returns Promise<TData>

getDefaultOptions

  • getDefaultOptions(): DefaultOptions<unknown>

  • Returns DefaultOptions<unknown>

getLogger

  • getLogger(): Logger

  • Returns Logger

getMutationCache

  • getMutationCache(): MutationCache

  • Returns MutationCache

getMutationDefaults

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

  • Parameters

    Returns undefined | MutationObserverOptions<any, any, any, any>

getQueriesData

  • getQueriesData<TQueryFnData>(queryKey): [QueryKey, undefined | TQueryFnData][]

  • Type Parameters

    • TQueryFnData = unknown

    Parameters

    Returns [QueryKey, undefined | TQueryFnData][]

  • getQueriesData<TQueryFnData>(filters): [QueryKey, undefined | TQueryFnData][]

  • Type Parameters

    • TQueryFnData = unknown

    Parameters

    Returns [QueryKey, undefined | TQueryFnData][]

getQueryCache

  • getQueryCache(): QueryCache

  • Returns QueryCache

getQueryData

  • getQueryData<TQueryFnData>(queryKey, filters?): undefined | TQueryFnData

  • Type Parameters

    • TQueryFnData = unknown

    Parameters

    Returns undefined | TQueryFnData

getQueryDefaults

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

  • Parameters

    Returns undefined | QueryObserverOptions<any, any, any, any, any>

getQueryState

  • getQueryState<TQueryFnData, TError>(queryKey, filters?): undefined | QueryState<TQueryFnData, TError>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = undefined

    Parameters

    Returns undefined | QueryState<TQueryFnData, TError>

invalidateQueries

  • invalidateQueries<TPageData>(filters?, options?): Promise<void>

  • Type Parameters

    • TPageData = unknown

    Parameters

    Returns Promise<void>

  • invalidateQueries<TPageData>(queryKey?, filters?, options?): Promise<void>

  • Type Parameters

    • TPageData = unknown

    Parameters

    Returns Promise<void>

isFetching

  • isFetching(filters?): number

  • Parameters

    Returns number

  • isFetching(queryKey?, filters?): number

  • Parameters

    Returns number

isMutating

  • isMutating(filters?): number

  • Parameters

    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 QueryKey = QueryKey

    Parameters

    Returns Promise<void>

  • prefetchInfiniteQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey, options?): Promise<void>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

    Returns Promise<void>

  • prefetchInfiniteQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey, queryFn, options?): Promise<void>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

    Returns Promise<void>

prefetchQuery

  • prefetchQuery<TQueryFnData, TError, TData, TQueryKey>(options): Promise<void>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = QueryKey

    Parameters

    Returns Promise<void>

  • prefetchQuery<TQueryFnData, TError, TData, TQueryKey>(queryKey, options?): Promise<void>

  • Type Parameters

    • TQueryFnData = unknown

    • TError = unknown

    • TData = TQueryFnData

    • TQueryKey extends QueryKey = 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 QueryKey = QueryKey

    Parameters

    Returns Promise<void>

refetchQueries

  • refetchQueries<TPageData>(filters?, options?): Promise<void>

  • Type Parameters

    • TPageData = unknown

    Parameters

    Returns Promise<void>

  • refetchQueries<TPageData>(queryKey?, filters?, options?): Promise<void>

  • Type Parameters

    • TPageData = unknown

    Parameters

    Returns Promise<void>

removeQueries

  • removeQueries(filters?): void

  • Parameters

    Returns void

  • removeQueries(queryKey?, filters?): void

  • Parameters

    Returns void

resetQueries

  • resetQueries<TPageData>(filters?, options?): Promise<void>

  • Type Parameters

    • TPageData = unknown

    Parameters

    Returns Promise<void>

  • resetQueries<TPageData>(queryKey?, filters?, options?): Promise<void>

  • Type Parameters

    • TPageData = unknown

    Parameters

    Returns Promise<void>

resumePausedMutations

  • resumePausedMutations(): Promise<unknown>

  • Returns Promise<unknown>

setDefaultOptions

  • setDefaultOptions(options): void

  • Parameters

    Returns void

setMutationDefaults

  • setMutationDefaults(mutationKey, options): void

  • Parameters

    Returns void

setQueriesData

  • setQueriesData<TQueryFnData>(queryKey, updater, options?): [QueryKey, undefined | TQueryFnData][]

  • Type Parameters

    • TQueryFnData

    Parameters

    Returns [QueryKey, undefined | TQueryFnData][]

  • setQueriesData<TQueryFnData>(filters, updater, options?): [QueryKey, undefined | TQueryFnData][]

  • Type Parameters

    • TQueryFnData

    Parameters

    Returns [QueryKey, undefined | TQueryFnData][]

setQueryData

  • setQueryData<TQueryFnData>(queryKey, updater, options?): undefined | TQueryFnData

  • Type Parameters

    • TQueryFnData

    Parameters

    Returns undefined | TQueryFnData

setQueryDefaults

  • setQueryDefaults(queryKey, options): void

  • Parameters

    Returns void

unmount

  • unmount(): void

  • Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc