kotlin-tanstack-react-query/tanstack.react.query/UseQueryOptions

UseQueryOptions

external interface UseQueryOptions<TQueryFnData, TError, TData, TQueryKey : QueryKey> : UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> (source)

Inheritors

UseSuspenseQueryOptions

Properties

abstract var _defaulted: Boolean?

_optimisticResults

abstract var _optimisticResults: String?

abstract var behavior: QueryBehavior<TQueryFnData, TError, TQueryFnData, TQueryKey>?

abstract var enabled: Enabled<TQueryFnData, TError, TQueryFnData, TQueryKey>?

experimental_prefetchInRender

abstract var experimental_prefetchInRender: Boolean?

abstract var gcTime: JsDuration?

abstract var initialData: InitialDataFunction<TQueryFnData>?

initialDataUpdatedAt

abstract var initialDataUpdatedAt: Any?

abstract var maxPages: Int?

abstract var meta: QueryMeta?

abstract var networkMode: NetworkMode?

notifyOnChangeProps

abstract var notifyOnChangeProps: NotifyOnChangeProps?

abstract var persister: QueryPersister<TQueryFnData, TQueryKey, Any?>?

placeholderData

abstract var placeholderData: Any?

abstract var queryFn: QueryFunctionOrSkipToken<TQueryFnData, TQueryKey, Any?>?

abstract var queryHash: String?

abstract var queryKey: TQueryKey?

abstract var queryKeyHashFn: QueryKeyHashFunction<TQueryKey>?

refetchInterval

abstract var refetchInterval: Any?

refetchIntervalInBackground

abstract var refetchIntervalInBackground: Boolean?

abstract var refetchOnMount: (query: Query<TQueryFnData, TError, TQueryFnData, TQueryKey>) -> Boolean?

refetchOnReconnect

abstract var refetchOnReconnect: (query: Query<TQueryFnData, TError, TQueryFnData, TQueryKey>) -> Boolean?

refetchOnWindowFocus

abstract var refetchOnWindowFocus: (query: Query<TQueryFnData, TError, TQueryFnData, TQueryKey>) -> Boolean?

abstract var retry: RetryValue<TError>?

abstract var retryDelay: RetryDelayValue<TError>?

abstract var retryOnMount: Boolean?

abstract var select: (data: TQueryFnData) -> TData?

abstract var staleTime: StaleTime<TQueryFnData, TError, TQueryFnData, TQueryKey>?

structuralSharing

abstract var structuralSharing: Any?

abstract var suspense: Boolean?

abstract var throwOnError: ThrowOnError<TQueryFnData, TError, TQueryFnData, TQueryKey>?