Package-level declarations

Types

Link copied to clipboard
Link copied to clipboard
typealias Action_1<TData, TError> = Union
Link copied to clipboard
typealias AnyDataTag = Any
Link copied to clipboard
Link copied to clipboard
typealias BatchNotifyFunction = (callback: () -> Unit) -> Unit
Link copied to clipboard
open external class CancelledError(options: CancelOptions = definedExternally) : Throwable
Link copied to clipboard
external interface CancelOptions
Link copied to clipboard
Link copied to clipboard
external interface ContinueAction
Link copied to clipboard
external interface ContinueAction_1
Link copied to clipboard
typealias DataTag<TType, TValue, TError> = Any
Link copied to clipboard
external object dataTagErrorSymbol : Symbol
Link copied to clipboard
external object dataTagSymbol : Symbol
Link copied to clipboard
typealias DefaultError = Any
Link copied to clipboard
external interface DefaultHydrateOptions
Link copied to clipboard
external interface DefaultOptions<TError>
Link copied to clipboard
external interface DehydratedMutation
Link copied to clipboard
external interface DehydratedQuery
Link copied to clipboard
external interface DehydratedState
Link copied to clipboard
external interface DehydrateOptions
Link copied to clipboard
Link copied to clipboard
external interface ErrorAction<TError>
Link copied to clipboard
external interface ErrorAction_1<TError>
Link copied to clipboard
external interface FailedAction<TError>
Link copied to clipboard
external interface FailedAction_1<TError>
Link copied to clipboard
typealias False = Boolean
Link copied to clipboard
external interface FetchAction
Link copied to clipboard
Link copied to clipboard
sealed external interface FetchDirection
Link copied to clipboard
external interface FetchMeta
Link copied to clipboard
external interface FetchNextPageOptions : ResultOptions
Link copied to clipboard
external interface FetchOptions<TData>
Link copied to clipboard
Link copied to clipboard
sealed external interface FetchStatus
Link copied to clipboard
open external class FocusManager : Subscribable<Listener>
Link copied to clipboard
typealias FocusManagerSetupFn = (setFocused: (focused: Boolean?) -> Unit) -> () -> Unit?
Link copied to clipboard
typealias GetNextPageParamFunction<TPageParam, TQueryFnData> = (lastPage: TQueryFnData, allPages: ReadonlyArray<TQueryFnData>, lastPageParam: TPageParam, allPageParams: ReadonlyArray<TPageParam>) -> TPageParam?
Link copied to clipboard
Link copied to clipboard
external interface HydrateOptions
Link copied to clipboard
external interface InfiniteData<TData, TPageParam>
Link copied to clipboard
typealias InitialDataFunction<T> = () -> T?
Link copied to clipboard
external interface InitialPageParam<TPageParam>
Link copied to clipboard
external interface InvalidateAction
Link copied to clipboard
external interface InvalidateOptions : RefetchOptions
Link copied to clipboard
typealias JsDuration = Double
Link copied to clipboard
typealias Listener = (online: Boolean) -> Unit
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open external class MutationCache(config: MutationCacheConfig = definedExternally) : Subscribable<MutationCacheListener>
Link copied to clipboard
external interface MutationCacheConfig
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
typealias MutationFunction<TData, TVariables> = (variables: TVariables) -> Promise<TData>
Link copied to clipboard
typealias MutationKey = Any
Link copied to clipboard
typealias MutationMeta = Any
Link copied to clipboard
Link copied to clipboard
typealias MutationScope = Any
Link copied to clipboard
Link copied to clipboard
sealed external interface MutationStatus
Link copied to clipboard
sealed external interface NetworkMode
Link copied to clipboard
typealias NotifyCallback = () -> Unit
Link copied to clipboard
external interface NotifyEvent
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
external interface NotifyEventQueryAdded : NotifyEvent
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
sealed external interface NotifyEventType
Link copied to clipboard
typealias NotifyFunction = (callback: () -> Unit) -> Unit
Link copied to clipboard
Link copied to clipboard
external interface NotifyOptions
Link copied to clipboard
Link copied to clipboard
open external class OnlineManager : Subscribable<Listener>
Link copied to clipboard
typealias OnlineManagerSetupFn = (setOnline: Listener) -> () -> Unit?
Link copied to clipboard
typealias Page = Any
Link copied to clipboard
typealias PageParam = Any
Link copied to clipboard
external interface PauseAction
Link copied to clipboard
external interface PauseAction_1
Link copied to clipboard
external interface PendingAction<TVariables, TContext>
Link copied to clipboard
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
Link copied to clipboard
typealias QueriesPlaceholderDataFunction<TQueryData> = (previousData: Void, previousQuery: Void) -> TQueryData?
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open external class QueryCache(config: QueryCacheConfig = definedExternally) : Subscribable<QueryCacheListener>
Link copied to clipboard
external interface QueryCacheConfig
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open external class QueryClient(config: QueryClientConfig = definedExternally)
Link copied to clipboard
external interface QueryClientConfig
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
sealed external interface QueryFunctionOrSkipToken<out T, out TQueryKey : QueryKey, out TPageParam>
Link copied to clipboard
external interface QueryKey
Link copied to clipboard
typealias QueryKeyHashFunction<TQueryKey> = (queryKey: TQueryKey) -> String
Link copied to clipboard
typealias QueryMeta = Any
Link copied to clipboard
external interface QueryObserverBaseResult<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
external interface QueryState<TData, TError>
Link copied to clipboard
sealed external interface QueryStatus
Link copied to clipboard
external interface QueryStore
Link copied to clipboard
sealed external interface QueryTypeFilter
Link copied to clipboard
external interface RefetchOptions : ResultOptions
Link copied to clipboard
external interface Register
Link copied to clipboard
abstract external class Removable
Link copied to clipboard
external interface ResetOptions : RefetchOptions
Link copied to clipboard
external interface ResultOptions
Link copied to clipboard
typealias RetryDelayFunction<TError> = (failureCount: Int, error: TError) -> Int
Link copied to clipboard
Link copied to clipboard
external interface Retryer<TData>
Link copied to clipboard
external interface RetryerConfig<TData, TError>
Link copied to clipboard
Link copied to clipboard
typealias ScheduleFunction = (callback: () -> Unit) -> Unit
Link copied to clipboard
external interface SetDataOptions
Link copied to clipboard
external interface SetStateAction<TData, TError>
Link copied to clipboard
external interface SetStateOptions
Link copied to clipboard
typealias ShouldRetryFunction<TError> = (failureCount: Int, error: TError) -> Boolean
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open external class Subscribable<TListener : Function<*>>
Link copied to clipboard
external interface SuccessAction<TData>
Link copied to clipboard
external interface SuccessAction_1<TData>
Link copied to clipboard
Link copied to clipboard
typealias TransformerFn = (data: Any?) -> Any?
Link copied to clipboard
typealias True = Boolean
Link copied to clipboard
typealias Type = String
Link copied to clipboard
typealias Union = Any
Link copied to clipboard
typealias UnsetMarker = Any
Link copied to clipboard
external object unsetMarker : Symbol
Link copied to clipboard
typealias Updater<TInput, TOutput> = (input: TInput) -> TOutput

Properties

Link copied to clipboard
Link copied to clipboard
external val isServer: Boolean
Link copied to clipboard
external val notifyManager: Any
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
external fun canFetch(networkMode: NetworkMode?): Boolean
Link copied to clipboard
external fun createNotifyManager(): Any
Link copied to clipboard
Link copied to clipboard
external fun defaultShouldDehydrateMutation(mutation: Mutation<*, *, *, *>): Boolean
Link copied to clipboard
external fun defaultShouldDehydrateQuery(query: Query<*, *, *, *>): Boolean
Link copied to clipboard
external fun dehydrate(client: QueryClient, options: DehydrateOptions = definedExternally): DehydratedState
Link copied to clipboard
Link copied to clipboard
external fun <TInput, TOutput> functionalUpdate(updater: Updater<TInput, TOutput>, input: TInput): TOutput
Link copied to clipboard
external fun hashKey(queryKey: Any): String
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
Link copied to clipboard
external fun isCancelledError(value: Any): Boolean
Link copied to clipboard
external fun isPlainArray(value: Any?): Boolean
Link copied to clipboard
external fun isPlainObject(o: Any): Boolean
Link copied to clipboard
external fun isValidTimeout(value: Any?): Boolean
Link copied to clipboard
external fun <T> keepPreviousData(previousData: T?): T?
Link copied to clipboard
external fun matchMutation(filters: MutationFilters<*, *, *, *>, mutation: Mutation<*, *, *, *>): Boolean
Link copied to clipboard
external fun matchQuery(filters: QueryFilters<*, *, *, *>, query: Query<*, *, *, *>): Boolean
Link copied to clipboard
external fun noop(): Void
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
inline fun <T : QueryKey> QueryKey(vararg keys: Comparable<*>): T
fun <T : QueryKey> QueryKey(parentKey: QueryKey, vararg keys: Comparable<*>): T
Link copied to clipboard
external fun <TData, TOptions : QueryOptions<*, *, *, *, *>> replaceData(prevData: TData?, data: TData, options: TOptions): TData
Link copied to clipboard
external fun <T> replaceEqualDeep(a: Any?, b: T): T
Link copied to clipboard
external fun <T : Any> shallowEqualObjects(a: T, b: T?): Boolean
Link copied to clipboard
external fun sleep(timeout: JsDuration): Promise<Void>
Link copied to clipboard
external fun timeUntilStale(updatedAt: EpochTimeStamp, staleTime: JsDuration = definedExternally): Int