kotlin-tanstack-query-core/tanstack.query.core/Query

Query

open external class Query<TQueryFnData, TError, TData, TQueryKey : QueryKey>(config: QueryConfig<TQueryFnData, TError, TData, TQueryKey>) : Removable(source)

Constructors

constructor(config: QueryConfig<TQueryFnData, TError, TData, TQueryKey>)

Properties

open var gcTime: JsDuration

open var meta: QueryMeta?

open var observers: ReadonlyArray<QueryObserver<*, *, *, *, *>>

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

open var promise: Promise<TData>?

open var queryHash: String

open var queryKey: TQueryKey

open var state: QueryState<TData, TError>

Functions

open fun addObserver(observer: QueryObserver<*, *, *, *, *>)

open fun cancel(options: CancelOptions = definedExternally): Promise<Void>

open override fun destroy()

open fun fetch(options: QueryOptions<TQueryFnData, TError, TData, TQueryKey, *> = definedExternally, fetchOptions: FetchOptions<TQueryFnData> = definedExternally): Promise<TData>

getObserversCount

open fun getObserversCount(): Int

open fun invalidate()

open fun isActive(): Boolean

open fun isDisabled(): Boolean

open fun isStale(): Boolean

open fun isStaleByTime(staleTime: JsDuration = definedExternally): Boolean

open fun onFocus()

open fun onOnline()

open fun removeObserver(observer: QueryObserver<*, *, *, *, *>)

open fun reset()

open fun setData(newData: TData, options: SetDataOptions = definedExternally): TData

open fun setOptions(options: QueryOptions<TQueryFnData, TError, TData, TQueryKey, *> = definedExternally)

open fun setState(state: QueryState<TData, TError>, setStateOptions: SetStateOptions = definedExternally)