mirror of
https://github.com/hanzoai/agency.git
synced 2026-11-02 19:13:28 +00:00
243 lines
5.6 KiB
Plaintext
243 lines
5.6 KiB
Plaintext
/* istanbul ignore file */
|
|
|
|
import type {
|
|
DefaultError,
|
|
DefinedInfiniteQueryObserverResult,
|
|
DefinedQueryObserverResult,
|
|
DistributiveOmit,
|
|
FetchQueryOptions,
|
|
InfiniteQueryObserverOptions,
|
|
InfiniteQueryObserverResult,
|
|
MutateFunction,
|
|
MutationObserverOptions,
|
|
MutationObserverResult,
|
|
OmitKeyof,
|
|
Override,
|
|
QueryKey,
|
|
QueryObserverOptions,
|
|
QueryObserverResult,
|
|
SkipToken,
|
|
} from '@tanstack/query-core'
|
|
|
|
export type AnyUseBaseQueryOptions = UseBaseQueryOptions<
|
|
any,
|
|
any,
|
|
any,
|
|
any,
|
|
any
|
|
>
|
|
export interface UseBaseQueryOptions<
|
|
TQueryFnData = unknown,
|
|
TError = DefaultError,
|
|
TData = TQueryFnData,
|
|
TQueryData = TQueryFnData,
|
|
TQueryKey extends QueryKey = QueryKey,
|
|
> extends QueryObserverOptions<
|
|
TQueryFnData,
|
|
TError,
|
|
TData,
|
|
TQueryData,
|
|
TQueryKey
|
|
> {
|
|
/**
|
|
* Set this to `false` to unsubscribe this observer from updates to the query cache.
|
|
* Defaults to `true`.
|
|
*/
|
|
subscribed?: boolean
|
|
}
|
|
|
|
export interface UsePrefetchQueryOptions<
|
|
TQueryFnData = unknown,
|
|
TError = DefaultError,
|
|
TData = TQueryFnData,
|
|
TQueryKey extends QueryKey = QueryKey,
|
|
> extends OmitKeyof<
|
|
FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
|
|
'queryFn'
|
|
> {
|
|
queryFn?: Exclude<
|
|
FetchQueryOptions<TQueryFnData, TError, TData, TQueryKey>['queryFn'],
|
|
SkipToken
|
|
>
|
|
}
|
|
|
|
export type AnyUseQueryOptions = UseQueryOptions<any, any, any, any>
|
|
export interface UseQueryOptions<
|
|
TQueryFnData = unknown,
|
|
TError = DefaultError,
|
|
TData = TQueryFnData,
|
|
TQueryKey extends QueryKey = QueryKey,
|
|
> extends OmitKeyof<
|
|
UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>,
|
|
'suspense'
|
|
> {}
|
|
|
|
export type AnyUseSuspenseQueryOptions = UseSuspenseQueryOptions<
|
|
any,
|
|
any,
|
|
any,
|
|
any
|
|
>
|
|
export interface UseSuspenseQueryOptions<
|
|
TQueryFnData = unknown,
|
|
TError = DefaultError,
|
|
TData = TQueryFnData,
|
|
TQueryKey extends QueryKey = QueryKey,
|
|
> extends OmitKeyof<
|
|
UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
|
|
'queryFn' | 'enabled' | 'throwOnError' | 'placeholderData'
|
|
> {
|
|
queryFn?: Exclude<
|
|
UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>['queryFn'],
|
|
SkipToken
|
|
>
|
|
}
|
|
|
|
export type AnyUseInfiniteQueryOptions = UseInfiniteQueryOptions<
|
|
any,
|
|
any,
|
|
any,
|
|
any,
|
|
any
|
|
>
|
|
export interface UseInfiniteQueryOptions<
|
|
TQueryFnData = unknown,
|
|
TError = DefaultError,
|
|
TData = TQueryFnData,
|
|
TQueryKey extends QueryKey = QueryKey,
|
|
TPageParam = unknown,
|
|
> extends OmitKeyof<
|
|
InfiniteQueryObserverOptions<
|
|
TQueryFnData,
|
|
TError,
|
|
TData,
|
|
TQueryKey,
|
|
TPageParam
|
|
>,
|
|
'suspense'
|
|
> {
|
|
/**
|
|
* Set this to `false` to unsubscribe this observer from updates to the query cache.
|
|
* Defaults to `true`.
|
|
*/
|
|
subscribed?: boolean
|
|
}
|
|
|
|
export type AnyUseSuspenseInfiniteQueryOptions =
|
|
UseSuspenseInfiniteQueryOptions<any, any, any, any, any>
|
|
export interface UseSuspenseInfiniteQueryOptions<
|
|
TQueryFnData = unknown,
|
|
TError = DefaultError,
|
|
TData = TQueryFnData,
|
|
TQueryKey extends QueryKey = QueryKey,
|
|
TPageParam = unknown,
|
|
> extends OmitKeyof<
|
|
UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>,
|
|
'queryFn' | 'enabled' | 'throwOnError' | 'placeholderData'
|
|
> {
|
|
queryFn?: Exclude<
|
|
UseInfiniteQueryOptions<
|
|
TQueryFnData,
|
|
TError,
|
|
TData,
|
|
TQueryKey,
|
|
TPageParam
|
|
>['queryFn'],
|
|
SkipToken
|
|
>
|
|
}
|
|
|
|
export type UseBaseQueryResult<
|
|
TData = unknown,
|
|
TError = DefaultError,
|
|
> = QueryObserverResult<TData, TError>
|
|
|
|
export type UseQueryResult<
|
|
TData = unknown,
|
|
TError = DefaultError,
|
|
> = UseBaseQueryResult<TData, TError>
|
|
|
|
export type UseSuspenseQueryResult<
|
|
TData = unknown,
|
|
TError = DefaultError,
|
|
> = DistributiveOmit<
|
|
DefinedQueryObserverResult<TData, TError>,
|
|
'isPlaceholderData' | 'promise'
|
|
>
|
|
|
|
export type DefinedUseQueryResult<
|
|
TData = unknown,
|
|
TError = DefaultError,
|
|
> = DefinedQueryObserverResult<TData, TError>
|
|
|
|
export type UseInfiniteQueryResult<
|
|
TData = unknown,
|
|
TError = DefaultError,
|
|
> = InfiniteQueryObserverResult<TData, TError>
|
|
|
|
export type DefinedUseInfiniteQueryResult<
|
|
TData = unknown,
|
|
TError = DefaultError,
|
|
> = DefinedInfiniteQueryObserverResult<TData, TError>
|
|
|
|
export type UseSuspenseInfiniteQueryResult<
|
|
TData = unknown,
|
|
TError = DefaultError,
|
|
> = OmitKeyof<
|
|
DefinedInfiniteQueryObserverResult<TData, TError>,
|
|
'isPlaceholderData' | 'promise'
|
|
>
|
|
|
|
export type AnyUseMutationOptions = UseMutationOptions<any, any, any, any>
|
|
export interface UseMutationOptions<
|
|
TData = unknown,
|
|
TError = DefaultError,
|
|
TVariables = void,
|
|
TOnMutateResult = unknown,
|
|
> extends OmitKeyof<
|
|
MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>,
|
|
'_defaulted'
|
|
> {}
|
|
|
|
export type UseMutateFunction<
|
|
TData = unknown,
|
|
TError = DefaultError,
|
|
TVariables = void,
|
|
TOnMutateResult = unknown,
|
|
> = (
|
|
...args: Parameters<
|
|
MutateFunction<TData, TError, TVariables, TOnMutateResult>
|
|
>
|
|
) => void
|
|
|
|
export type UseMutateAsyncFunction<
|
|
TData = unknown,
|
|
TError = DefaultError,
|
|
TVariables = void,
|
|
TOnMutateResult = unknown,
|
|
> = MutateFunction<TData, TError, TVariables, TOnMutateResult>
|
|
|
|
export type UseBaseMutationResult<
|
|
TData = unknown,
|
|
TError = DefaultError,
|
|
TVariables = unknown,
|
|
TOnMutateResult = unknown,
|
|
> = Override<
|
|
MutationObserverResult<TData, TError, TVariables, TOnMutateResult>,
|
|
{ mutate: UseMutateFunction<TData, TError, TVariables, TOnMutateResult> }
|
|
> & {
|
|
mutateAsync: UseMutateAsyncFunction<
|
|
TData,
|
|
TError,
|
|
TVariables,
|
|
TOnMutateResult
|
|
>
|
|
}
|
|
|
|
export type UseMutationResult<
|
|
TData = unknown,
|
|
TError = DefaultError,
|
|
TVariables = unknown,
|
|
TOnMutateResult = unknown,
|
|
> = UseBaseMutationResult<TData, TError, TVariables, TOnMutateResult>
|