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 external var options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, *>

Functions

open external fun destroy()

fetchOptimistic

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

getCurrentQuery

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

getCurrentResult

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

getOptimisticResult

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

open external fun hasListeners(): Boolean

open external fun onQueryUpdate()

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

open external fun setOptions(options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, *>)

shouldFetchOnReconnect

open external fun shouldFetchOnReconnect(): Boolean

shouldFetchOnWindowFocus

open external fun shouldFetchOnWindowFocus(): Boolean

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

open external fun trackProp(key: String)

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

open external fun updateResult()