kotlin-tanstack-query-core/tanstack.query.core/InfiniteQueryObserver

InfiniteQueryObserver

open external class InfiniteQueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey : QueryKey, TPageParam>(client: QueryClient, options: InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>) : QueryObserver<TQueryFnData, TError, TData, InfiniteData<TQueryData, TPageParam>, TQueryKey> (source)

Constructors

InfiniteQueryObserver

constructor(client: QueryClient, options: InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>)

Properties

getCurrentResult

open var getCurrentResult: () -> InfiniteQueryObserverResult<TData, TError>

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

open var subscribe: (InfiniteQueryObserverListener<TData, TError>?) -> () -> Unit

Functions

open fun destroy()

open fun fetchNextPage(options: FetchNextPageOptions = definedExternally): Promise<InfiniteQueryObserverResult<TData, TError>>

fetchOptimistic

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

fetchPreviousPage

open fun fetchPreviousPage(options: FetchPreviousPageOptions = definedExternally): Promise<InfiniteQueryObserverResult<TData, TError>>

getCurrentQuery

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

getCurrentResult

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

getOptimisticResult

open override fun getOptimisticResult(options: DefaultedInfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>): InfiniteQueryObserverResult<TData, TError>

open fun hasListeners(): Boolean

open fun onQueryUpdate()

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

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

open fun setOptions(options: QueryObserverOptions<TQueryFnData, TError, TData, InfiniteData<TQueryData, TPageParam>, 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)