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

Package-level declarations

Types

DefinedUseInfiniteQueryResult

typealias DefinedUseInfiniteQueryResult<TData, TError> = DefinedInfiniteQueryObserverResult<TData, TError>

DefinedUseQueryResult

typealias DefinedUseQueryResult<TData, TError> = DefinedQueryObserverResult<TData, TError>

HydrationBoundaryProps

external interface HydrationBoundaryProps : PropsWithChildren

MutationStateOptions

typealias MutationStateOptions<TResult> = Any

QueryClientProviderProps

external interface QueryClientProviderProps : PropsWithChildren

QueryErrorResetBoundaryProps

external interface QueryErrorResetBoundaryProps : Props

QueryErrorResetBoundaryValue

external interface QueryErrorResetBoundaryValue

UseBaseMutationResult

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

UseBaseQueryOptions

external interface UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey : QueryKey> : QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, Any?>

UseBaseQueryResult

typealias UseBaseQueryResult<TData, TError> = QueryObserverResult<TData, TError>

UseInfiniteQueryOptions

external interface UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey : QueryKey, TPageParam> : InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>

UseInfiniteQueryResult

typealias UseInfiniteQueryResult<TData, TError> = InfiniteQueryObserverResult<TData, TError>

UseMutateAsyncFunction

typealias UseMutateAsyncFunction<TData, TError, TVariables, TContext> = MutateFunction<TData, TError, TVariables, TContext>

UseMutateFunction

typealias UseMutateFunction<TData, TError, TVariables, TContext> = Function<Unit>

UseMutationOptions

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

UseMutationResult

typealias UseMutationResult<TData, TError, TVariables, TContext> = UseBaseMutationResult<TData, TError, TVariables, TContext>

UseQueryOptions

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

UseQueryResult

typealias UseQueryResult<TData, TError> = UseBaseQueryResult<TData, TError>

UseSuspenseInfiniteQueryOptions

external interface UseSuspenseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey : QueryKey, TPageParam> : UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>

UseSuspenseInfiniteQueryResult

typealias UseSuspenseInfiniteQueryResult<TData, TError> = DefinedInfiniteQueryObserverResult<TData, TError>

UseSuspenseQueryOptions

external interface UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey : QueryKey> : UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>

UseSuspenseQueryResult

typealias UseSuspenseQueryResult<TData, TError> = DefinedQueryObserverResult<TData, TError>

Properties

HydrationBoundary

external val HydrationBoundary: FC<HydrationBoundaryProps>

IsRestoringProvider

external val IsRestoringProvider: Provider<Boolean>

QueryClientContext

external val QueryClientContext: Context<QueryClient?>

QueryClientProvider

external val QueryClientProvider: FC<QueryClientProviderProps>

QueryErrorResetBoundary

external val QueryErrorResetBoundary: FC<QueryErrorResetBoundaryProps>

useIsRestoring

external val useIsRestoring: () -> Boolean

useQueryErrorResetBoundary

external val useQueryErrorResetBoundary: () -> QueryErrorResetBoundaryValue

Functions

useBaseQuery

external fun <TQueryFnData, TError, TData, TQueryData, TQueryKey : QueryKey> useBaseQuery(options: UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, Observer: JsClass<QueryObserver<*, *, *, *, *>>, queryClient: QueryClient = definedExternally): QueryObserverResult<TData, TError>

useInfiniteQuery

external fun <TQueryFnData, TError, TData, TQueryKey : QueryKey, TPageParam> useInfiniteQuery(options: UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, TPageParam>, queryClient: QueryClient = definedExternally): UseInfiniteQueryResult<TData, TError>

useIsFetching

external fun useIsFetching(filters: QueryFilters = definedExternally, queryClient: QueryClient = definedExternally): Int

useIsMutating

external fun useIsMutating(filters: MutationFilters = definedExternally, queryClient: QueryClient = definedExternally): Int

useMutation

external fun <TData, TError, TVariables, TContext> useMutation(options: UseMutationOptions<TData, TError, TVariables, TContext>, queryClient: QueryClient = definedExternally): UseMutationResult<TData, TError, TVariables, TContext>

useMutationState

external fun <TResult> useMutationState(options: MutationStateOptions<TResult> = definedExternally, queryClient: QueryClient = definedExternally): ReadonlyArray<TResult>

usePrefetchInfiniteQuery

external fun <TQueryFnData, TError, TData, TQueryKey : QueryKey, TPageParam> usePrefetchInfiniteQuery(options: FetchInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, queryClient: QueryClient = definedExternally)

usePrefetchQuery

external fun <TQueryFnData, TError, TData, TQueryKey : QueryKey> usePrefetchQuery(options: FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey, *>, queryClient: QueryClient = definedExternally)

useQuery

external fun <TQueryFnData, TError, TData, TQueryKey : QueryKey> useQuery(options: UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient: QueryClient = definedExternally): UseQueryResult<TData, TError>

useQueryClient

external fun useQueryClient(queryClient: QueryClient = definedExternally): QueryClient

useSuspenseInfiniteQuery

external fun <TQueryFnData, TError, TData, TQueryKey : QueryKey, TPageParam> useSuspenseInfiniteQuery(options: UseSuspenseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, TPageParam>, queryClient: QueryClient = definedExternally): UseSuspenseInfiniteQueryResult<TData, TError>

useSuspenseQuery

external fun <TQueryFnData, TError, TData, TQueryKey : QueryKey> useSuspenseQuery(options: UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient: QueryClient = definedExternally): UseSuspenseQueryResult<TData, TError>