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

Package-level declarations

Types

Action

typealias Action<TData, TError, TVariables, TContext> = Union

Action_1

typealias Action_1<TData, TError> = Union

BatchCallsCallback

typealias BatchCallsCallback<T> = Function<Unit>

BatchNotifyFunction

typealias BatchNotifyFunction = (callback: () -> Unit) -> Unit

CancelledError

open external class CancelledError(options: CancelOptions = definedExternally) : Throwable

CancelOptions

external interface CancelOptions

CombineFn

typealias CombineFn<TCombinedResult> = (result: ReadonlyArray<QueryObserverResult<*, *>>) -> TCombinedResult

ContinueAction

external interface ContinueAction

ContinueAction_1

external interface ContinueAction_1

DataTag

typealias DataTag<TType, TValue> = Any

dataTagSymbol

external object dataTagSymbol : Symbol

DefaultedInfiniteQueryObserverOptions

typealias DefaultedInfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam> = Union

DefaultedQueryObserverOptions

typealias DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> = Union

DefaultError

typealias DefaultError = Any

DefaultHydrateOptions

external interface DefaultHydrateOptions

DefaultOptions

external interface DefaultOptions<TError>

DefinedInfiniteQueryObserverResult

external interface DefinedInfiniteQueryObserverResult<TData, TError> : InfiniteQueryObserverBaseResult<TData, TError>

DefinedQueryObserverResult

external interface DefinedQueryObserverResult<TData, TError> : QueryObserverBaseResult<TData, TError>

DehydratedMutation

external interface DehydratedMutation

DehydratedQuery

external interface DehydratedQuery

DehydratedState

external interface DehydratedState

DehydrateOptions

external interface DehydrateOptions

Enabled

typealias Enabled<TQueryFnData, TError, TData, TQueryKey> = (query: Query<TQueryFnData, TError, TData, TQueryKey>) -> Boolean

EnsureInfiniteQueryDataOptions

typealias EnsureInfiniteQueryDataOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> = Any

EnsureQueryDataOptions

external interface EnsureQueryDataOptions<TQueryFnData, TError, TData, TQueryKey : QueryKey, TPageParam> : FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>

ErrorAction

external interface ErrorAction<TError>

ErrorAction_1

external interface ErrorAction_1<TError>

FailedAction

external interface FailedAction<TError>

FailedAction_1

external interface FailedAction_1<TError>

False

typealias False = Boolean

FetchAction

external interface FetchAction

FetchContext

external interface FetchContext<TQueryFnData, TError, TData, TQueryKey : QueryKey>

FetchDirection

sealed external interface FetchDirection

FetchInfiniteQueryOptions

typealias FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> = FetchQueryOptions<TQueryFnData, TError, InfiniteData<TData, TPageParam>, TQueryKey, TPageParam>

FetchInfiniteQueryPages

typealias FetchInfiniteQueryPages<TQueryFnData, TPageParam> = Any

FetchMeta

external interface FetchMeta

FetchNextPageOptions

external interface FetchNextPageOptions : ResultOptions

FetchOptions

external interface FetchOptions<TData>

FetchPreviousPageOptions

external interface FetchPreviousPageOptions : ResultOptions

FetchQueryOptions

external interface FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey : QueryKey, TPageParam> : QueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>

FetchStatus

sealed external interface FetchStatus

FocusManager

open external class FocusManager : Subscribable<Listener>

FocusManagerSetupFn

typealias FocusManagerSetupFn = (setFocused: (focused: Boolean?) -> Unit) -> () -> Unit?

GetNextPageParamFunction

typealias GetNextPageParamFunction<TPageParam, TQueryFnData> = (lastPage: TQueryFnData, allPages: ReadonlyArray<TQueryFnData>, lastPageParam: TPageParam, allPageParams: ReadonlyArray<TPageParam>) -> TPageParam?

GetPreviousPageParamFunction

typealias GetPreviousPageParamFunction<TPageParam, TQueryFnData> = (firstPage: TQueryFnData, allPages: ReadonlyArray<TQueryFnData>, firstPageParam: TPageParam, allPageParams: ReadonlyArray<TPageParam>) -> TPageParam?

HydrateOptions

external interface HydrateOptions

InfiniteData

external interface InfiniteData<TData, TPageParam>

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>

InfiniteQueryObserverBaseResult

external interface InfiniteQueryObserverBaseResult<TData, TError> : QueryObserverResult<TData, TError>

InfiniteQueryObserverListener

typealias InfiniteQueryObserverListener<TData, TError> = (result: InfiniteQueryObserverResult<TData, TError>) -> Unit

InfiniteQueryObserverLoadingErrorResult

external interface InfiniteQueryObserverLoadingErrorResult<TData, TError> : InfiniteQueryObserverResult<TData, TError>

InfiniteQueryObserverLoadingResult

external interface InfiniteQueryObserverLoadingResult<TData, TError> : InfiniteQueryObserverResult<TData, TError>

InfiniteQueryObserverOptions

external interface InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey : QueryKey, TPageParam> : QueryObserverOptions<TQueryFnData, TError, TData, InfiniteData<TQueryData, TPageParam>, TQueryKey, TPageParam> , InfiniteQueryPageParamsOptions<TQueryFnData, TPageParam>

InfiniteQueryObserverPendingResult

external interface InfiniteQueryObserverPendingResult<TData, TError> : InfiniteQueryObserverResult<TData, TError>

InfiniteQueryObserverRefetchErrorResult

external interface InfiniteQueryObserverRefetchErrorResult<TData, TError> : InfiniteQueryObserverResult<TData, TError>

InfiniteQueryObserverResult

external interface InfiniteQueryObserverResult<TData, TError> : InfiniteQueryObserverBaseResult<TData, TError>

InfiniteQueryObserverSuccessResult

external interface InfiniteQueryObserverSuccessResult<TData, TError> : InfiniteQueryObserverResult<TData, TError>

InfiniteQueryPageParamsOptions

external interface InfiniteQueryPageParamsOptions<TQueryFnData, TPageParam> : InitialPageParam<TPageParam>

InitialDataFunction

typealias InitialDataFunction<T> = () -> T?

InitialPageParam

external interface InitialPageParam<TPageParam>

InvalidateAction

external interface InvalidateAction

InvalidateOptions

external interface InvalidateOptions : RefetchOptions

InvalidateQueryFilters

external interface InvalidateQueryFilters : QueryFilters

JsDuration

typealias JsDuration = Double

Listener

typealias Listener = (online: Boolean) -> Unit

MutateFunction

typealias MutateFunction<TData, TError, TVariables, TContext> = (variables: TVariables, options: MutateOptions<TData, TError, TVariables, TContext>?) -> Promise<TData>

MutateOptions

external interface MutateOptions<TData, TError, TVariables, TContext>

Mutation

open external class Mutation<TData, TError, TVariables, TContext>(config: MutationConfig<TData, TError, TVariables, TContext>) : Removable

MutationCache

open external class MutationCache(config: MutationCacheConfig = definedExternally) : Subscribable<MutationCacheListener>

MutationCacheConfig

external interface MutationCacheConfig

MutationCacheListener

typealias MutationCacheListener = (event: MutationCacheNotifyEvent) -> Unit

MutationCacheNotifyEvent

typealias MutationCacheNotifyEvent = Union

MutationConfig

external interface MutationConfig<TData, TError, TVariables, TContext>

MutationFilters

external interface MutationFilters

MutationFunction

typealias MutationFunction<TData, TVariables> = (variables: TVariables) -> Promise<TData>

MutationKey

typealias MutationKey = Any

MutationMeta

typealias MutationMeta = Any

MutationObserver

open external class MutationObserver<TData, TError, TVariables, TContext>(client: QueryClient, options: MutationObserverOptions<TData, TError, TVariables, TContext>) : Subscribable<MutationObserverListener<TData, TError, TVariables, TContext>>

MutationObserverBaseResult

external interface MutationObserverBaseResult<TData, TError, TVariables, TContext> : MutationState<TData, TError, TVariables, TContext>

MutationObserverErrorResult

external interface MutationObserverErrorResult<TData, TError, TVariables, TContext> : MutationObserverResult<TData, TError, TVariables, TContext>

MutationObserverIdleResult

external interface MutationObserverIdleResult<TData, TError, TVariables, TContext> : MutationObserverResult<TData, TError, TVariables, TContext>

MutationObserverListener

typealias MutationObserverListener<TData, TError, TVariables, TContext> = (result: MutationObserverResult<TData, TError, TVariables, TContext>) -> Unit

MutationObserverLoadingResult

external interface MutationObserverLoadingResult<TData, TError, TVariables, TContext> : MutationObserverResult<TData, TError, TVariables, TContext>

MutationObserverOptions

external interface MutationObserverOptions<TData, TError, TVariables, TContext> : MutationOptions<TData, TError, TVariables, TContext>

MutationObserverResult

external interface MutationObserverResult<TData, TError, TVariables, TContext> : MutationObserverBaseResult<TData, TError, TVariables, TContext>

MutationObserverSuccessResult

external interface MutationObserverSuccessResult<TData, TError, TVariables, TContext> : MutationObserverResult<TData, TError, TVariables, TContext>

MutationOptions

external interface MutationOptions<TData, TError, TVariables, TContext>

MutationScope

typealias MutationScope = Any

MutationState

external interface MutationState<TData, TError, TVariables, TContext>

MutationStatus

sealed external interface MutationStatus

NetworkMode

sealed external interface NetworkMode

NotifyCallback

typealias NotifyCallback = () -> Unit

NotifyEvent

external interface NotifyEvent

NotifyEventMutationAdded

external interface NotifyEventMutationAdded : NotifyEvent

NotifyEventMutationObserverAdded

external interface NotifyEventMutationObserverAdded : NotifyEvent

NotifyEventMutationObserverOptionsUpdated

external interface NotifyEventMutationObserverOptionsUpdated : NotifyEvent

NotifyEventMutationObserverRemoved

external interface NotifyEventMutationObserverRemoved : NotifyEvent

NotifyEventMutationRemoved

external interface NotifyEventMutationRemoved : NotifyEvent

NotifyEventMutationUpdated

external interface NotifyEventMutationUpdated : NotifyEvent

NotifyEventQueryAdded

external interface NotifyEventQueryAdded : NotifyEvent

NotifyEventQueryObserverAdded

external interface NotifyEventQueryObserverAdded : NotifyEvent

NotifyEventQueryObserverOptionsUpdated

external interface NotifyEventQueryObserverOptionsUpdated : NotifyEvent

NotifyEventQueryObserverRemoved

external interface NotifyEventQueryObserverRemoved : NotifyEvent

NotifyEventQueryObserverResultsUpdated

external interface NotifyEventQueryObserverResultsUpdated : NotifyEvent

NotifyEventQueryRemoved

external interface NotifyEventQueryRemoved : NotifyEvent

NotifyEventQueryUpdated

external interface NotifyEventQueryUpdated : NotifyEvent

NotifyEventType

sealed external interface NotifyEventType

NotifyFunction

typealias NotifyFunction = (callback: () -> Unit) -> Unit

NotifyOnChangeProps

typealias NotifyOnChangeProps = Union

NotifyOptions

external interface NotifyOptions

ObserverFetchOptions

external interface ObserverFetchOptions<TData> : FetchOptions<TData>

OnlineManager

open external class OnlineManager : Subscribable<Listener>

OnlineManagerSetupFn

typealias OnlineManagerSetupFn = (setOnline: Listener) -> () -> Unit?

Page

typealias Page = Any

PageParam

typealias PageParam = Any

PauseAction

external interface PauseAction

PauseAction_1

external interface PauseAction_1

PendingAction

external interface PendingAction<TVariables, TContext>

PlaceholderDataFunction

typealias PlaceholderDataFunction<TQueryFnData, TError, TQueryData, TQueryKey> = (previousData: TQueryData?, previousQuery: Query<TQueryFnData, TError, TQueryData, TQueryKey>?) -> TQueryData?

QueriesObserver

open external class QueriesObserver<TCombinedResult>(client: QueryClient, queries: ReadonlyArray<QueryObserverOptions<*, *, *, *, *, *>>, options: QueriesObserverOptions<TCombinedResult> = definedExternally) : Subscribable<QueriesObserverListener>

QueriesObserverListener

typealias QueriesObserverListener = (result: ReadonlyArray<QueryObserverResult<*, *>>) -> Unit

QueriesObserverOptimisticResult

typealias QueriesObserverOptimisticResult<TCombinedResult> = JsTuple3<ReadonlyArray<QueryObserverResult<*, *>>, (r: ReadonlyArray<QueryObserverResult<*, *>>?) -> TCombinedResult, () -> ReadonlyArray<QueryObserverResult<*, *>>>

QueriesObserverOptions

external interface QueriesObserverOptions<TCombinedResult>

QueriesPlaceholderDataFunction

typealias QueriesPlaceholderDataFunction<TQueryData> = (previousData: Void, previousQuery: Void) -> TQueryData?

Query

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

QueryBehavior

external interface QueryBehavior<TQueryFnData, TError, TData, TQueryKey : QueryKey>

QueryCache

open external class QueryCache(config: QueryCacheConfig = definedExternally) : Subscribable<QueryCacheListener>

QueryCacheConfig

external interface QueryCacheConfig

QueryCacheListener

typealias QueryCacheListener = (event: QueryCacheNotifyEvent) -> Unit

QueryCacheNotifyEvent

typealias QueryCacheNotifyEvent = Union

QueryClient

open external class QueryClient(config: QueryClientConfig = definedExternally)

QueryClientConfig

external interface QueryClientConfig

QueryConfig

external interface QueryConfig<TQueryFnData, TError, TData, TQueryKey : QueryKey>

QueryFilters

external interface QueryFilters

QueryFunction

sealed external interface QueryFunction<out T, out TQueryKey : QueryKey, out TPageParam> : QueryFunctionOrSkipToken<T, TQueryKey, TPageParam>

QueryFunctionContext

external interface QueryFunctionContext<TQueryKey : QueryKey, TPageParam>

QueryFunctionOrSkipToken

sealed external interface QueryFunctionOrSkipToken<out T, out TQueryKey : QueryKey, out TPageParam>

QueryKey

external interface QueryKey

QueryKeyHashFunction

typealias QueryKeyHashFunction<TQueryKey> = (queryKey: TQueryKey) -> String

QueryMeta

typealias QueryMeta = Any

QueryObserver

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

QueryObserverBaseResult

external interface QueryObserverBaseResult<TData, TError>

QueryObserverListener

typealias QueryObserverListener<TData, TError> = (result: QueryObserverResult<TData, TError>) -> Unit

QueryObserverLoadingErrorResult

external interface QueryObserverLoadingErrorResult<TData, TError> : QueryObserverResult<TData, TError>

QueryObserverLoadingResult

external interface QueryObserverLoadingResult<TData, TError> : QueryObserverResult<TData, TError>

QueryObserverOptions

external interface QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey : QueryKey, TPageParam> : QueryOptions<TQueryFnData, TError, TQueryData, TQueryKey, TPageParam>

QueryObserverPendingResult

external interface QueryObserverPendingResult<TData, TError> : QueryObserverResult<TData, TError>

QueryObserverRefetchErrorResult

external interface QueryObserverRefetchErrorResult<TData, TError> : QueryObserverResult<TData, TError>

QueryObserverResult

external interface QueryObserverResult<TData, TError> : QueryObserverBaseResult<TData, TError>

QueryObserverSuccessResult

external interface QueryObserverSuccessResult<TData, TError> : QueryObserverResult<TData, TError>

QueryOptions

external interface QueryOptions<TQueryFnData, TError, TData, TQueryKey : QueryKey, TPageParam>

QueryPersister

typealias QueryPersister<T, TQueryKey, TPageParam> = (queryFn: QueryFunction<T, TQueryKey, TPageParam>, context: QueryFunctionContext<TQueryKey, *>, query: Query<*, *, *, *>) -> PromiseResult<T>

QueryState

external interface QueryState<TData, TError>

QueryStatus

sealed external interface QueryStatus

QueryStore

external interface QueryStore

QueryTypeFilter

sealed external interface QueryTypeFilter

RefetchOptions

external interface RefetchOptions : ResultOptions

RefetchQueryFilters

external interface RefetchQueryFilters : QueryFilters

external interface Register

Removable

abstract external class Removable

ResetOptions

external interface ResetOptions : RefetchOptions

ResultOptions

external interface ResultOptions

RetryDelayFunction

typealias RetryDelayFunction<TError> = (failureCount: Int, error: TError) -> Int

RetryDelayValue

typealias RetryDelayValue<TError> = RetryDelayFunction<TError>

Retryer

external interface Retryer<TData>

RetryerConfig

external interface RetryerConfig<TData, TError>

RetryValue

typealias RetryValue<TError> = ShouldRetryFunction<TError>

ScheduleFunction

typealias ScheduleFunction = (callback: () -> Unit) -> Unit

SetDataOptions

external interface SetDataOptions

SetStateAction

external interface SetStateAction<TData, TError>

SetStateOptions

external interface SetStateOptions

ShouldRetryFunction

typealias ShouldRetryFunction<TError> = (failureCount: Int, error: TError) -> Boolean

skipToken

external object skipToken : Symbol, QueryFunctionOrSkipToken<Nothing, Nothing, Nothing>

StaleTime

typealias StaleTime<TQueryFnData, TError, TData, TQueryKey> = (query: Query<TQueryFnData, TError, TData, TQueryKey>) -> Number

Subscribable

open external class Subscribable<TListener : Function<*>>

SuccessAction

external interface SuccessAction<TData>

SuccessAction_1

external interface SuccessAction_1<TData>

ThrowOnError

typealias ThrowOnError<TQueryFnData, TError, TQueryData, TQueryKey> = (error: TError, query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) -> Boolean

TransformerFn

typealias TransformerFn = (data: Any?) -> Any?

True

typealias True = Boolean

Type

typealias Type = String

Union

typealias Union = Any

Updater

typealias Updater<TInput, TOutput> = (input: TInput) -> TOutput

Properties

focusManager

external val focusManager: FocusManager

isServer

external val isServer: Boolean

notifyManager

external val notifyManager: Any

onlineManager

external val onlineManager: OnlineManager

Functions

addToEnd

external fun <T> addToEnd(items: ReadonlyArray<T>, item: T, max: Int = definedExternally): ReadonlyArray<T>

addToStart

external fun <T> addToStart(items: ReadonlyArray<T>, item: T, max: Int = definedExternally): ReadonlyArray<T>

canFetch

external fun canFetch(networkMode: NetworkMode?): Boolean

createNotifyManager

external fun createNotifyManager(): Any

createRetryer

external fun <TData, TError> createRetryer(config: RetryerConfig<TData, TError>): Retryer<TData>

defaultShouldDehydrateMutation

external fun defaultShouldDehydrateMutation(mutation: Mutation<*, *, *, *>): Boolean

defaultShouldDehydrateQuery

external fun defaultShouldDehydrateQuery(query: Query<*, *, *, *>): Boolean

dehydrate

external fun dehydrate(client: QueryClient, options: DehydrateOptions = definedExternally): DehydratedState

fetchState

external fun <TQueryFnData, TError, TData, TQueryKey : QueryKey> fetchState(data: TData?, options: QueryOptions<TQueryFnData, TError, TData, TQueryKey, *>): Any

functionalUpdate

external fun <TInput, TOutput> functionalUpdate(updater: Updater<TInput, TOutput>, input: TInput): TOutput

getDefaultState

external fun <TData, TError, TVariables, TContext> getDefaultState(): MutationState<TData, TError, TVariables, TContext>

hashKey

external fun hashKey(queryKey: Any): String

hashQueryKeyByOptions

external fun <TQueryKey : QueryKey> hashQueryKeyByOptions(queryKey: TQueryKey, options: QueryOptions<*, *, *, *, *> = definedExternally): String

hasNextPage

external fun hasNextPage(options: InfiniteQueryPageParamsOptions<*, *>, data: InfiniteData<*, *> = definedExternally): Boolean

hasPreviousPage

external fun hasPreviousPage(options: InfiniteQueryPageParamsOptions<*, *>, data: InfiniteData<*, *> = definedExternally): Boolean

hydrate

external fun hydrate(client: QueryClient, dehydratedState: Any?, options: HydrateOptions = definedExternally)

infiniteQueryBehavior

external fun <TQueryFnData, TError, TData, TPageParam> infiniteQueryBehavior(pages: Int = definedExternally): QueryBehavior<TQueryFnData, TError, InfiniteData<TData, TPageParam>, *>

isCancelledError

external fun isCancelledError(value: Any): Boolean

isPlainArray

external fun isPlainArray(value: Any?): Boolean

isPlainObject

external fun isPlainObject(o: Any): Boolean

isValidTimeout

external fun isValidTimeout(value: Any?): Boolean

keepPreviousData

external fun <T> keepPreviousData(previousData: T?): T?

matchMutation

external fun matchMutation(filters: MutationFilters, mutation: Mutation<*, *, *, *>): Boolean

matchQuery

external fun matchQuery(filters: QueryFilters, query: Query<*, *, *, *>): Boolean

noop

external fun noop(): Void

partialMatchKey

external fun partialMatchKey(a: QueryKey, b: QueryKey): Boolean

QueryFunction

inline fun <T, TQueryKey : QueryKey, TPageParam> QueryFunction(noinline value: (context: QueryFunctionContext<TQueryKey, TPageParam>) -> PromiseResult<T>): QueryFunction<T, TQueryKey, TPageParam>

QueryKey

inline fun <T : QueryKey> QueryKey(vararg keys: Comparable<*>): T

fun <T : QueryKey> QueryKey(parentKey: QueryKey, vararg keys: Comparable<*>): T

replaceData

external fun <TData, TOptions : QueryOptions<*, *, *, *, *>> replaceData(prevData: TData?, data: TData, options: TOptions): TData

replaceEqualDeep

external fun <T> replaceEqualDeep(a: Any?, b: T): T

resolveEnabled

external fun <TQueryFnData, TError, TData, TQueryKey : QueryKey> resolveEnabled(enabled: Enabled<TQueryFnData, TError, TData, TQueryKey>?, query: Query<TQueryFnData, TError, TData, TQueryKey>): Boolean?

resolveStaleTime

external fun <TQueryFnData, TError, TData, TQueryKey : QueryKey> resolveStaleTime(staleTime: StaleTime<TQueryFnData, TError, TData, TQueryKey>?, query: Query<TQueryFnData, TError, TData, TQueryKey>): JsDuration?

shallowEqualObjects

external fun <T : Any> shallowEqualObjects(a: T, b: T?): Boolean

sleep

external fun sleep(timeout: JsDuration): Promise<Void>

timeUntilStale

external fun timeUntilStale(updatedAt: EpochTimeStamp, staleTime: JsDuration = definedExternally): Int