Package-level declarations
Types
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
typealias CombineFn<TCombinedResult> = (result: ReadonlyArray<QueryObserverResult<*, *>>) -> TCombinedResult
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
typealias DefaultedInfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam> = Union
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external interface DefinedInfiniteQueryObserverResult<TData, TError> : InfiniteQueryObserverBaseResult<TData, TError>
Link copied to clipboard
external interface DefinedQueryObserverResult<TData, TError> : QueryObserverBaseResult<TData, TError>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external interface EnsureQueryDataOptions<TQueryFnData, TError, TData, TQueryKey : QueryKey, TPageParam> : FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
typealias FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> = FetchQueryOptions<TQueryFnData, TError, InfiniteData<TData, TPageParam>, TQueryKey, TPageParam>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external interface FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey : QueryKey, TPageParam> : QueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
typealias GetNextPageParamFunction<TPageParam, TQueryFnData> = (lastPage: TQueryFnData, allPages: ReadonlyArray<TQueryFnData>, lastPageParam: TPageParam, allPageParams: ReadonlyArray<TPageParam>) -> TPageParam?
Link copied to clipboard
typealias GetPreviousPageParamFunction<TPageParam, TQueryFnData> = (firstPage: TQueryFnData, allPages: ReadonlyArray<TQueryFnData>, firstPageParam: TPageParam, allPageParams: ReadonlyArray<TPageParam>) -> TPageParam?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
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>
Link copied to clipboard
external interface InfiniteQueryObserverBaseResult<TData, TError> : QueryObserverResult<TData, TError>
Link copied to clipboard
typealias InfiniteQueryObserverListener<TData, TError> = (result: InfiniteQueryObserverResult<TData, TError>) -> Unit
Link copied to clipboard
external interface InfiniteQueryObserverLoadingErrorResult<TData, TError> : InfiniteQueryObserverResult<TData, TError>
Link copied to clipboard
external interface InfiniteQueryObserverLoadingResult<TData, TError> : InfiniteQueryObserverResult<TData, TError>
Link copied to clipboard
external interface InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey : QueryKey, TPageParam> : QueryObserverOptions<TQueryFnData, TError, TData, InfiniteData<TQueryData, TPageParam>, TQueryKey, TPageParam> , InfiniteQueryPageParamsOptions<TQueryFnData, TPageParam>
Link copied to clipboard
external interface InfiniteQueryObserverPendingResult<TData, TError> : InfiniteQueryObserverResult<TData, TError>
Link copied to clipboard
external interface InfiniteQueryObserverRefetchErrorResult<TData, TError> : InfiniteQueryObserverResult<TData, TError>
Link copied to clipboard
external interface InfiniteQueryObserverResult<TData, TError> : InfiniteQueryObserverBaseResult<TData, TError>
Link copied to clipboard
external interface InfiniteQueryObserverSuccessResult<TData, TError> : InfiniteQueryObserverResult<TData, TError>
Link copied to clipboard
external interface InfiniteQueryPageParamsOptions<TQueryFnData, TPageParam> : InitialPageParam<TPageParam>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external interface InvalidateQueryFilters<TQueryFnData, TError, TData, TQueryKey : QueryKey> : QueryFilters<TQueryFnData, TError, TData, TQueryKey>
Link copied to clipboard
Link copied to clipboard
typealias MutateFunction<TData, TError, TVariables, TContext> = (variables: TVariables, options: MutateOptions<TData, TError, TVariables, TContext>?) -> Promise<TData>
Link copied to clipboard
Link copied to clipboard
open external class Mutation<TData, TError, TVariables, TContext>(config: MutationConfig<TData, TError, TVariables, TContext>) : Removable
Link copied to clipboard
open external class MutationCache(config: MutationCacheConfig = definedExternally) : Subscribable<MutationCacheListener>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open external class MutationObserver<TData, TError, TVariables, TContext>(client: QueryClient, options: MutationObserverOptions<TData, TError, TVariables, TContext>) : Subscribable<MutationObserverListener<TData, TError, TVariables, TContext>>
Link copied to clipboard
external interface MutationObserverBaseResult<TData, TError, TVariables, TContext> : MutationState<TData, TError, TVariables, TContext>
Link copied to clipboard
external interface MutationObserverErrorResult<TData, TError, TVariables, TContext> : MutationObserverResult<TData, TError, TVariables, TContext>
Link copied to clipboard
external interface MutationObserverIdleResult<TData, TError, TVariables, TContext> : MutationObserverResult<TData, TError, TVariables, TContext>
Link copied to clipboard
typealias MutationObserverListener<TData, TError, TVariables, TContext> = (result: MutationObserverResult<TData, TError, TVariables, TContext>) -> Unit
Link copied to clipboard
external interface MutationObserverLoadingResult<TData, TError, TVariables, TContext> : MutationObserverResult<TData, TError, TVariables, TContext>
Link copied to clipboard
external interface MutationObserverOptions<TData, TError, TVariables, TContext> : MutationOptions<TData, TError, TVariables, TContext>
Link copied to clipboard
external interface MutationObserverResult<TData, TError, TVariables, TContext> : MutationObserverBaseResult<TData, TError, TVariables, TContext>
Link copied to clipboard
external interface MutationObserverSuccessResult<TData, TError, TVariables, TContext> : MutationObserverResult<TData, TError, TVariables, TContext>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
typealias PlaceholderDataFunction<TQueryFnData, TError, TQueryData, TQueryKey> = (previousData: TQueryData?, previousQuery: Query<TQueryFnData, TError, TQueryData, TQueryKey>?) -> TQueryData?
Link copied to clipboard
open external class QueriesObserver<TCombinedResult>(client: QueryClient, queries: ReadonlyArray<QueryObserverOptions<*, *, *, *, *, *>>, options: QueriesObserverOptions<TCombinedResult> = definedExternally) : Subscribable<QueriesObserverListener>
Link copied to clipboard
Link copied to clipboard
typealias QueriesObserverOptimisticResult<TCombinedResult> = JsTuple3<ReadonlyArray<QueryObserverResult<*, *>>, (r: ReadonlyArray<QueryObserverResult<*, *>>?) -> TCombinedResult, () -> ReadonlyArray<QueryObserverResult<*, *>>>
Link copied to clipboard
Link copied to clipboard
typealias QueriesPlaceholderDataFunction<TQueryData> = (previousData: Void, previousQuery: Void) -> TQueryData?
Link copied to clipboard
open external class Query<TQueryFnData, TError, TData, TQueryKey : QueryKey>(config: QueryConfig<TQueryFnData, TError, TData, TQueryKey>) : Removable
Link copied to clipboard
Link copied to clipboard
open external class QueryCache(config: QueryCacheConfig = definedExternally) : Subscribable<QueryCacheListener>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed external interface QueryFunction<out T, out TQueryKey : QueryKey, out TPageParam> : QueryFunctionOrSkipToken<T, TQueryKey, TPageParam>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open external class QueryObserver<TQueryFnData, TError, TData, TQueryData, TQueryKey : QueryKey>(client: QueryClient, options: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, *>) : Subscribable<QueryObserverListener<TData, TError>>
Link copied to clipboard
Link copied to clipboard
typealias QueryObserverListener<TData, TError> = (result: QueryObserverResult<TData, TError>) -> Unit
Link copied to clipboard
external interface QueryObserverLoadingErrorResult<TData, TError> : QueryObserverResult<TData, TError>
Link copied to clipboard
Link copied to clipboard
external interface QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey : QueryKey, TPageParam> : QueryOptions<TQueryFnData, TError, TQueryData, TQueryKey, TPageParam>
Link copied to clipboard
Link copied to clipboard
external interface QueryObserverRefetchErrorResult<TData, TError> : QueryObserverResult<TData, TError>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
typealias QueryPersister<T, TQueryKey, TPageParam> = (queryFn: QueryFunction<T, TQueryKey, TPageParam>, context: QueryFunctionContext<TQueryKey, *>, query: Query<*, *, *, *>) -> PromiseResult<T>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external interface RefetchQueryFilters<TQueryFnData, TError, TData, TQueryKey : QueryKey> : QueryFilters<TQueryFnData, TError, TData, TQueryKey>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
typealias ThrowOnError<TQueryFnData, TError, TQueryData, TQueryKey> = (error: TError, query: Query<TQueryFnData, TError, TQueryData, TQueryKey>) -> Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Functions
Link copied to clipboard
external fun <T> addToEnd(items: ReadonlyArray<T>, item: T, max: Int = definedExternally): ReadonlyArray<T>
Link copied to clipboard
external fun <T> addToStart(items: ReadonlyArray<T>, item: T, max: Int = definedExternally): ReadonlyArray<T>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external fun dehydrate(client: QueryClient, options: DehydrateOptions = definedExternally): DehydratedState
Link copied to clipboard
external fun <TQueryFnData, TError, TData, TQueryKey : QueryKey> fetchState(data: TData?, options: QueryOptions<TQueryFnData, TError, TData, TQueryKey, *>): Any
Link copied to clipboard
Link copied to clipboard
external fun <TData, TError, TVariables, TContext> getDefaultState(): MutationState<TData, TError, TVariables, TContext>
Link copied to clipboard
external fun <TQueryKey : QueryKey> hashQueryKeyByOptions(queryKey: TQueryKey, options: QueryOptions<*, *, *, *, *> = definedExternally): String
Link copied to clipboard
external fun hasNextPage(options: InfiniteQueryPageParamsOptions<*, *>, data: InfiniteData<*, *> = definedExternally): Boolean
Link copied to clipboard
external fun hasPreviousPage(options: InfiniteQueryPageParamsOptions<*, *>, data: InfiniteData<*, *> = definedExternally): Boolean
Link copied to clipboard
external fun hydrate(client: QueryClient, dehydratedState: Any?, options: HydrateOptions = definedExternally)
Link copied to clipboard
external fun <TQueryFnData, TError, TData, TPageParam> infiniteQueryBehavior(pages: Int = definedExternally): QueryBehavior<TQueryFnData, TError, InfiniteData<TData, TPageParam>, *>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external fun matchMutation(filters: MutationFilters<*, *, *, *>, mutation: Mutation<*, *, *, *>): Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
inline fun <T, TQueryKey : QueryKey, TPageParam> QueryFunction(noinline value: (context: QueryFunctionContext<TQueryKey, TPageParam>) -> PromiseResult<T>): QueryFunction<T, TQueryKey, TPageParam>
Link copied to clipboard
external fun <TData, TOptions : QueryOptions<*, *, *, *, *>> replaceData(prevData: TData?, data: TData, options: TOptions): TData
Link copied to clipboard
Link copied to clipboard
external fun <TQueryFnData, TError, TData, TQueryKey : QueryKey> resolveEnabled(enabled: Enabled<TQueryFnData, TError, TData, TQueryKey>?, query: Query<TQueryFnData, TError, TData, TQueryKey>): Boolean?
Link copied to clipboard
external fun <TQueryFnData, TError, TData, TQueryKey : QueryKey> resolveStaleTime(staleTime: StaleTime<TQueryFnData, TError, TData, TQueryKey>?, query: Query<TQueryFnData, TError, TData, TQueryKey>): JsDuration?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external fun timeUntilStale(updatedAt: EpochTimeStamp, staleTime: JsDuration = definedExternally): Int