kotlin-tanstack-query-core/tanstack.query.core/QueryClient

QueryClient

open external class QueryClient(config: QueryClientConfig = definedExternally)(source)

Constructors

constructor(config: QueryClientConfig = definedExternally)

Functions

open fun <TTaggedQueryKey : QueryKey> cancelQueries(filters: QueryFilters<TTaggedQueryKey> = definedExternally, cancelOptions: CancelOptions = definedExternally): Promise<Void?>

clear

open fun clear()

defaultMutationOptions

open fun <T : MutationOptions<*, *, *, *>> defaultMutationOptions(options: T = definedExternally): T

defaultQueryOptions

open fun <TQueryFnData, TError, TData, TQueryData, TQueryKey : QueryKey, TPageParam> defaultQueryOptions(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>): DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>

ensureInfiniteQueryData

open fun <TQueryFnData, TError, TData, TQueryKey : QueryKey, TPageParam> ensureInfiniteQueryData(options: EnsureInfiniteQueryDataOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): Promise<InfiniteData<TData, TPageParam>>

ensureQueryData

open fun <TQueryFnData, TError, TData, TQueryKey : QueryKey> ensureQueryData(options: EnsureQueryDataOptions<TQueryFnData, TError, TData, TQueryKey, *>): Promise<TData>

fetchInfiniteQuery

open fun <TQueryFnData, TError, TData, TQueryKey : QueryKey, TPageParam> fetchInfiniteQuery(options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): Promise<InfiniteData<TData, TPageParam>>

fetchQuery

open fun <TQueryFnData, TError, TData, TQueryKey : QueryKey, TPageParam> fetchQuery(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): Promise<TData>

getDefaultOptions

open fun getDefaultOptions(): DefaultOptions<*>

getMutationCache

open fun getMutationCache(): MutationCache

getMutationDefaults

open fun getMutationDefaults(mutationKey: MutationKey): MutationObserverOptions<*, *, *, *>

getQueriesData

open fun <TQueryFnData, TQueryFilters : QueryFilters<*>> getQueriesData(filters: TQueryFilters): ReadonlyArray<Tuple2<QueryKey, TQueryFnData?>>

getQueryCache

open fun getQueryCache(): QueryCache

getQueryData

open fun <TQueryFnData> getQueryData(queryKey: QueryKey): TQueryFnData?

getQueryDefaults

open fun getQueryDefaults(queryKey: QueryKey): QueryObserverOptions<*, *, *, *, *, *>

getQueryState

open fun <TQueryFnData, TError> getQueryState(queryKey: QueryKey): QueryState<TQueryFnData, TError>?

invalidateQueries

open fun <TTaggedQueryKey : QueryKey> invalidateQueries(filters: InvalidateQueryFilters<TTaggedQueryKey> = definedExternally, options: InvalidateOptions = definedExternally): Promise<Void?>

isFetching

open fun <TQueryFilters : QueryFilters<*>> isFetching(filters: TQueryFilters = definedExternally): Int

isMutating

open fun <TMutationFilters : MutationFilters<*, *, *, *>> isMutating(filters: TMutationFilters = definedExternally): Int

mount

open fun mount()

prefetchInfiniteQuery

open fun <TQueryFnData, TError, TData, TQueryKey : QueryKey, TPageParam> prefetchInfiniteQuery(options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>): Promise<Void?>

prefetchQuery

open fun <TQueryFnData, TError, TData, TQueryKey : QueryKey> prefetchQuery(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, *>): Promise<Void?>

refetchQueries

open fun <TTaggedQueryKey : QueryKey> refetchQueries(filters: RefetchQueryFilters<TTaggedQueryKey> = definedExternally, options: RefetchOptions = definedExternally): Promise<Void?>

removeQueries

open fun <TTaggedQueryKey : QueryKey> removeQueries(filters: QueryFilters<TTaggedQueryKey> = definedExternally)

resetQueries

open fun <TTaggedQueryKey : QueryKey> resetQueries(filters: QueryFilters<TTaggedQueryKey> = definedExternally, options: ResetOptions = definedExternally): Promise<Void?>

resumePausedMutations

open fun resumePausedMutations(): Promise<*>

setDefaultOptions

open fun setDefaultOptions(options: DefaultOptions<*>)

setMutationDefaults

open fun <TData, TError, TVariables, TContext> setMutationDefaults(mutationKey: MutationKey, options: MutationObserverOptions<TData, TError, TVariables, TContext>)

setQueriesData

open fun <TQueryFnData, TQueryFilters : QueryFilters<*>> setQueriesData(filters: TQueryFilters, updater: Updater<TQueryFnData?, TQueryFnData?>, options: SetDataOptions = definedExternally): ReadonlyArray<Tuple2<QueryKey, TQueryFnData?>>

setQueryData

open fun <TQueryFnData> setQueryData(queryKey: QueryKey, updater: Updater<TQueryFnData?, TQueryFnData?>, options: SetDataOptions = definedExternally): TQueryFnData?

setQueryDefaults

open fun <TQueryFnData, TError, TData, TQueryData> setQueryDefaults(queryKey: QueryKey, options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, *, *>)

unmount

open fun unmount()