kotlin-tanstack-query-core/tanstack.query.core/QueryObserver

QueryObserver

open external class QueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey : QueryKey>(client: QueryClient, options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, *>) : Subscribable<QueryObserverListener<TData, TError>> (source)

Inheritors

InfiniteQueryObserver

Constructors

constructor(client: QueryClient, options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, *>)

Properties

open var options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, *>

Functions

open fun destroy()

fetchOptimistic

open fun fetchOptimistic(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, *>): Promise<QueryObserverResult<TData, TError>>

getCurrentQuery

open fun getCurrentQuery(): Query<TQueryFnData, TError, TQueryData, TQueryKey>

getCurrentResult

open fun getCurrentResult(): QueryObserverResult<TData, TError>

getOptimisticResult

open fun getOptimisticResult(options: DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>): QueryObserverResult<TData, TError>

open fun hasListeners(): Boolean

open fun onQueryUpdate()

open fun refetch(options: RefetchOptions = definedExternally): Promise<QueryObserverResult<TData, TError>>

open fun setOptions(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, *>, notifyOptions: NotifyOptions = definedExternally)

shouldFetchOnReconnect

open fun shouldFetchOnReconnect(): Boolean

shouldFetchOnWindowFocus

open fun shouldFetchOnWindowFocus(): Boolean

open fun subscribe(listener: QueryObserverListener<TData, TError>): () -> Unit

open fun trackProp(key: String)

open fun trackResult(result: QueryObserverResult<TData, TError>, onPropTracked: (key: String) -> Unit = definedExternally): QueryObserverResult<TData, TError>

open fun updateResult(notifyOptions: NotifyOptions = definedExternally)