@tanstack/react-query-persist-client 4.0.10 → 4.0.11-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/{types/packages/react-query-persist-client/src → lib}/PersistQueryClientProvider.d.ts +0 -0
- package/build/{types/packages/react-query-persist-client/src → lib}/index.d.ts +0 -0
- package/build/lib/index.js +225 -0
- package/build/lib/index.js.map +1 -0
- package/build/{cjs/react-query-persist-client/src/persist.js → lib/index.mjs} +89 -12
- package/build/lib/index.mjs.map +1 -0
- package/build/{types/packages/react-query-persist-client/src → lib}/persist.d.ts +0 -0
- package/build/{types/packages/react-query-persist-client/src → lib}/retryStrategies.d.ts +0 -0
- package/build/umd/index.development.js +6 -303
- package/build/umd/index.development.js.map +1 -1
- package/build/umd/index.production.js +1 -11
- package/build/umd/index.production.js.map +1 -1
- package/package.json +20 -8
- package/build/cjs/_virtual/_rollupPluginBabelHelpers.js +0 -33
- package/build/cjs/_virtual/_rollupPluginBabelHelpers.js.map +0 -1
- package/build/cjs/query-core/build/esm/index.js +0 -314
- package/build/cjs/query-core/build/esm/index.js.map +0 -1
- package/build/cjs/react-query-persist-client/src/PersistQueryClientProvider.js +0 -83
- package/build/cjs/react-query-persist-client/src/PersistQueryClientProvider.js.map +0 -1
- package/build/cjs/react-query-persist-client/src/index.js +0 -27
- package/build/cjs/react-query-persist-client/src/index.js.map +0 -1
- package/build/cjs/react-query-persist-client/src/persist.js.map +0 -1
- package/build/cjs/react-query-persist-client/src/retryStrategies.js +0 -39
- package/build/cjs/react-query-persist-client/src/retryStrategies.js.map +0 -1
- package/build/esm/index.js +0 -492
- package/build/esm/index.js.map +0 -1
- package/build/stats-html.html +0 -2689
- package/build/stats.json +0 -217
- package/build/types/packages/query-core/src/focusManager.d.ts +0 -16
- package/build/types/packages/query-core/src/hydration.d.ts +0 -34
- package/build/types/packages/query-core/src/index.d.ts +0 -20
- package/build/types/packages/query-core/src/infiniteQueryBehavior.d.ts +0 -15
- package/build/types/packages/query-core/src/infiniteQueryObserver.d.ts +0 -18
- package/build/types/packages/query-core/src/logger.d.ts +0 -8
- package/build/types/packages/query-core/src/mutation.d.ts +0 -70
- package/build/types/packages/query-core/src/mutationCache.d.ts +0 -52
- package/build/types/packages/query-core/src/mutationObserver.d.ts +0 -23
- package/build/types/packages/query-core/src/notifyManager.d.ts +0 -18
- package/build/types/packages/query-core/src/onlineManager.d.ts +0 -16
- package/build/types/packages/query-core/src/queriesObserver.d.ts +0 -23
- package/build/types/packages/query-core/src/query.d.ts +0 -119
- package/build/types/packages/query-core/src/queryCache.d.ts +0 -59
- package/build/types/packages/query-core/src/queryClient.d.ts +0 -65
- package/build/types/packages/query-core/src/queryObserver.d.ts +0 -61
- package/build/types/packages/query-core/src/removable.d.ts +0 -9
- package/build/types/packages/query-core/src/retryer.d.ts +0 -33
- package/build/types/packages/query-core/src/subscribable.d.ts +0 -10
- package/build/types/packages/query-core/src/types.d.ts +0 -417
- package/build/types/packages/query-core/src/utils.d.ts +0 -99
- package/build/types/packages/react-query/src/Hydrate.d.ts +0 -10
- package/build/types/packages/react-query/src/QueryClientProvider.d.ts +0 -24
- package/build/types/packages/react-query/src/QueryErrorResetBoundary.d.ts +0 -12
- package/build/types/packages/react-query/src/index.d.ts +0 -17
- package/build/types/packages/react-query/src/isRestoring.d.ts +0 -3
- package/build/types/packages/react-query/src/reactBatchedUpdates.d.ts +0 -2
- package/build/types/packages/react-query/src/setBatchUpdatesFn.d.ts +0 -1
- package/build/types/packages/react-query/src/types.d.ts +0 -35
- package/build/types/packages/react-query/src/useBaseQuery.d.ts +0 -3
- package/build/types/packages/react-query/src/useInfiniteQuery.d.ts +0 -5
- package/build/types/packages/react-query/src/useIsFetching.d.ts +0 -7
- package/build/types/packages/react-query/src/useIsMutating.d.ts +0 -7
- package/build/types/packages/react-query/src/useMutation.d.ts +0 -6
- package/build/types/packages/react-query/src/useQueries.d.ts +0 -49
- package/build/types/packages/react-query/src/useQuery.d.ts +0 -23
- package/build/types/packages/react-query/src/utils.d.ts +0 -1
- package/build/types/packages/react-query-persist-client/src/__tests__/PersistQueryClientProvider.test.d.ts +0 -1
- package/build/types/packages/react-query-persist-client/src/__tests__/persist.test.d.ts +0 -1
- package/build/types/tests/utils.d.ts +0 -24
|
@@ -1,99 +0,0 @@
|
|
|
1
|
-
import type { Mutation } from './mutation';
|
|
2
|
-
import type { Query } from './query';
|
|
3
|
-
import type { FetchStatus, MutationFunction, MutationKey, MutationOptions, QueryFunction, QueryKey, QueryOptions } from './types';
|
|
4
|
-
export interface QueryFilters {
|
|
5
|
-
/**
|
|
6
|
-
* Filter to active queries, inactive queries or all queries
|
|
7
|
-
*/
|
|
8
|
-
type?: QueryTypeFilter;
|
|
9
|
-
/**
|
|
10
|
-
* Match query key exactly
|
|
11
|
-
*/
|
|
12
|
-
exact?: boolean;
|
|
13
|
-
/**
|
|
14
|
-
* Include queries matching this predicate function
|
|
15
|
-
*/
|
|
16
|
-
predicate?: (query: Query) => boolean;
|
|
17
|
-
/**
|
|
18
|
-
* Include queries matching this query key
|
|
19
|
-
*/
|
|
20
|
-
queryKey?: QueryKey;
|
|
21
|
-
/**
|
|
22
|
-
* Include or exclude stale queries
|
|
23
|
-
*/
|
|
24
|
-
stale?: boolean;
|
|
25
|
-
/**
|
|
26
|
-
* Include queries matching their fetchStatus
|
|
27
|
-
*/
|
|
28
|
-
fetchStatus?: FetchStatus;
|
|
29
|
-
}
|
|
30
|
-
export interface MutationFilters {
|
|
31
|
-
/**
|
|
32
|
-
* Match mutation key exactly
|
|
33
|
-
*/
|
|
34
|
-
exact?: boolean;
|
|
35
|
-
/**
|
|
36
|
-
* Include mutations matching this predicate function
|
|
37
|
-
*/
|
|
38
|
-
predicate?: (mutation: Mutation<any, any, any>) => boolean;
|
|
39
|
-
/**
|
|
40
|
-
* Include mutations matching this mutation key
|
|
41
|
-
*/
|
|
42
|
-
mutationKey?: MutationKey;
|
|
43
|
-
/**
|
|
44
|
-
* Include or exclude fetching mutations
|
|
45
|
-
*/
|
|
46
|
-
fetching?: boolean;
|
|
47
|
-
}
|
|
48
|
-
export declare type DataUpdateFunction<TInput, TOutput> = (input: TInput) => TOutput;
|
|
49
|
-
export declare type Updater<TInput, TOutput> = TOutput | DataUpdateFunction<TInput, TOutput>;
|
|
50
|
-
export declare type QueryTypeFilter = 'all' | 'active' | 'inactive';
|
|
51
|
-
export declare const isServer: boolean;
|
|
52
|
-
export declare function noop(): undefined;
|
|
53
|
-
export declare function functionalUpdate<TInput, TOutput>(updater: Updater<TInput, TOutput>, input: TInput): TOutput;
|
|
54
|
-
export declare function isValidTimeout(value: unknown): value is number;
|
|
55
|
-
export declare function difference<T>(array1: T[], array2: T[]): T[];
|
|
56
|
-
export declare function replaceAt<T>(array: T[], index: number, value: T): T[];
|
|
57
|
-
export declare function timeUntilStale(updatedAt: number, staleTime?: number): number;
|
|
58
|
-
export declare function parseQueryArgs<TOptions extends QueryOptions<any, any, any, TQueryKey>, TQueryKey extends QueryKey = QueryKey>(arg1: TQueryKey | TOptions, arg2?: QueryFunction<any, TQueryKey> | TOptions, arg3?: TOptions): TOptions;
|
|
59
|
-
export declare function parseMutationArgs<TOptions extends MutationOptions<any, any, any, any>>(arg1: MutationKey | MutationFunction<any, any> | TOptions, arg2?: MutationFunction<any, any> | TOptions, arg3?: TOptions): TOptions;
|
|
60
|
-
export declare function parseFilterArgs<TFilters extends QueryFilters, TOptions = unknown>(arg1?: QueryKey | TFilters, arg2?: TFilters | TOptions, arg3?: TOptions): [TFilters, TOptions | undefined];
|
|
61
|
-
export declare function parseMutationFilterArgs<TFilters extends MutationFilters, TOptions = unknown>(arg1?: QueryKey | TFilters, arg2?: TFilters | TOptions, arg3?: TOptions): [TFilters, TOptions | undefined];
|
|
62
|
-
export declare function matchQuery(filters: QueryFilters, query: Query<any, any, any, any>): boolean;
|
|
63
|
-
export declare function matchMutation(filters: MutationFilters, mutation: Mutation<any, any>): boolean;
|
|
64
|
-
export declare function hashQueryKeyByOptions<TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, options?: QueryOptions<any, any, any, TQueryKey>): string;
|
|
65
|
-
/**
|
|
66
|
-
* Default query keys hash function.
|
|
67
|
-
* Hashes the value into a stable hash.
|
|
68
|
-
*/
|
|
69
|
-
export declare function hashQueryKey(queryKey: QueryKey): string;
|
|
70
|
-
/**
|
|
71
|
-
* Checks if key `b` partially matches with key `a`.
|
|
72
|
-
*/
|
|
73
|
-
export declare function partialMatchKey(a: QueryKey, b: QueryKey): boolean;
|
|
74
|
-
/**
|
|
75
|
-
* Checks if `b` partially matches with `a`.
|
|
76
|
-
*/
|
|
77
|
-
export declare function partialDeepEqual(a: any, b: any): boolean;
|
|
78
|
-
/**
|
|
79
|
-
* This function returns `a` if `b` is deeply equal.
|
|
80
|
-
* If not, it will replace any deeply equal children of `b` with those of `a`.
|
|
81
|
-
* This can be used for structural sharing between JSON values for example.
|
|
82
|
-
*/
|
|
83
|
-
export declare function replaceEqualDeep<T>(a: unknown, b: T): T;
|
|
84
|
-
/**
|
|
85
|
-
* Shallow compare objects. Only works with objects that always have the same properties.
|
|
86
|
-
*/
|
|
87
|
-
export declare function shallowEqualObjects<T>(a: T, b: T): boolean;
|
|
88
|
-
export declare function isPlainArray(value: unknown): boolean;
|
|
89
|
-
export declare function isPlainObject(o: any): o is Object;
|
|
90
|
-
export declare function isQueryKey(value: unknown): value is QueryKey;
|
|
91
|
-
export declare function isError(value: any): value is Error;
|
|
92
|
-
export declare function sleep(timeout: number): Promise<void>;
|
|
93
|
-
/**
|
|
94
|
-
* Schedules a microtask.
|
|
95
|
-
* This can be useful to schedule state updates after rendering.
|
|
96
|
-
*/
|
|
97
|
-
export declare function scheduleMicrotask(callback: () => void): void;
|
|
98
|
-
export declare function getAbortController(): AbortController | undefined;
|
|
99
|
-
export declare function replaceData<TData, TOptions extends QueryOptions<any, any, any, any>>(prevData: TData | undefined, data: TData, options: TOptions): TData;
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
import * as React from 'react';
|
|
2
|
-
import { HydrateOptions } from '@tanstack/query-core';
|
|
3
|
-
import { ContextOptions } from './types';
|
|
4
|
-
export declare function useHydrate(state: unknown, options?: HydrateOptions & ContextOptions): void;
|
|
5
|
-
export interface HydrateProps {
|
|
6
|
-
state?: unknown;
|
|
7
|
-
options?: HydrateOptions;
|
|
8
|
-
children?: React.ReactNode;
|
|
9
|
-
}
|
|
10
|
-
export declare const Hydrate: ({ children, options, state }: HydrateProps) => React.ReactElement<any, string | React.JSXElementConstructor<any>>;
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
import * as React from 'react';
|
|
2
|
-
import { QueryClient } from '@tanstack/query-core';
|
|
3
|
-
import { ContextOptions } from './types';
|
|
4
|
-
declare global {
|
|
5
|
-
interface Window {
|
|
6
|
-
ReactQueryClientContext?: React.Context<QueryClient | undefined>;
|
|
7
|
-
}
|
|
8
|
-
}
|
|
9
|
-
export declare const defaultContext: React.Context<QueryClient | undefined>;
|
|
10
|
-
export declare const useQueryClient: ({ context }?: ContextOptions) => QueryClient;
|
|
11
|
-
declare type QueryClientProviderPropsBase = {
|
|
12
|
-
client: QueryClient;
|
|
13
|
-
children?: React.ReactNode;
|
|
14
|
-
};
|
|
15
|
-
declare type QueryClientProviderPropsWithContext = ContextOptions & {
|
|
16
|
-
contextSharing?: never;
|
|
17
|
-
} & QueryClientProviderPropsBase;
|
|
18
|
-
declare type QueryClientProviderPropsWithContextSharing = {
|
|
19
|
-
context?: never;
|
|
20
|
-
contextSharing?: boolean;
|
|
21
|
-
} & QueryClientProviderPropsBase;
|
|
22
|
-
export declare type QueryClientProviderProps = QueryClientProviderPropsWithContext | QueryClientProviderPropsWithContextSharing;
|
|
23
|
-
export declare const QueryClientProvider: ({ client, children, context, contextSharing, }: QueryClientProviderProps) => JSX.Element;
|
|
24
|
-
export {};
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
import * as React from 'react';
|
|
2
|
-
interface QueryErrorResetBoundaryValue {
|
|
3
|
-
clearReset: () => void;
|
|
4
|
-
isReset: () => boolean;
|
|
5
|
-
reset: () => void;
|
|
6
|
-
}
|
|
7
|
-
export declare const useQueryErrorResetBoundary: () => QueryErrorResetBoundaryValue;
|
|
8
|
-
export interface QueryErrorResetBoundaryProps {
|
|
9
|
-
children: ((value: QueryErrorResetBoundaryValue) => React.ReactNode) | React.ReactNode;
|
|
10
|
-
}
|
|
11
|
-
export declare const QueryErrorResetBoundary: ({ children, }: QueryErrorResetBoundaryProps) => JSX.Element;
|
|
12
|
-
export {};
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
import './setBatchUpdatesFn';
|
|
2
|
-
export * from '@tanstack/query-core';
|
|
3
|
-
export * from './types';
|
|
4
|
-
export { useQueries } from './useQueries';
|
|
5
|
-
export type { QueriesResults, QueriesOptions } from './useQueries';
|
|
6
|
-
export { useQuery } from './useQuery';
|
|
7
|
-
export { defaultContext, QueryClientProvider, useQueryClient, } from './QueryClientProvider';
|
|
8
|
-
export type { QueryClientProviderProps } from './QueryClientProvider';
|
|
9
|
-
export type { QueryErrorResetBoundaryProps } from './QueryErrorResetBoundary';
|
|
10
|
-
export { useHydrate, Hydrate } from './Hydrate';
|
|
11
|
-
export type { HydrateProps } from './Hydrate';
|
|
12
|
-
export { QueryErrorResetBoundary, useQueryErrorResetBoundary, } from './QueryErrorResetBoundary';
|
|
13
|
-
export { useIsFetching } from './useIsFetching';
|
|
14
|
-
export { useIsMutating } from './useIsMutating';
|
|
15
|
-
export { useMutation } from './useMutation';
|
|
16
|
-
export { useInfiniteQuery } from './useInfiniteQuery';
|
|
17
|
-
export { useIsRestoring, IsRestoringProvider } from './isRestoring';
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
import * as React from 'react';
|
|
2
|
-
import { InfiniteQueryObserverOptions, InfiniteQueryObserverResult, MutationObserverResult, QueryObserverOptions, QueryObserverResult, QueryKey, MutationObserverOptions, MutateFunction } from '@tanstack/query-core';
|
|
3
|
-
import type { QueryClient } from '@tanstack/query-core';
|
|
4
|
-
export interface ContextOptions {
|
|
5
|
-
/**
|
|
6
|
-
* Use this to pass your React Query context. Otherwise, `defaultContext` will be used.
|
|
7
|
-
*/
|
|
8
|
-
context?: React.Context<QueryClient | undefined>;
|
|
9
|
-
}
|
|
10
|
-
export interface UseBaseQueryOptions<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends ContextOptions, QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> {
|
|
11
|
-
}
|
|
12
|
-
export interface UseQueryOptions<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> {
|
|
13
|
-
}
|
|
14
|
-
export interface UseInfiniteQueryOptions<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends ContextOptions, InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> {
|
|
15
|
-
}
|
|
16
|
-
export declare type UseBaseQueryResult<TData = unknown, TError = unknown> = QueryObserverResult<TData, TError>;
|
|
17
|
-
export declare type UseQueryResult<TData = unknown, TError = unknown> = UseBaseQueryResult<TData, TError>;
|
|
18
|
-
export declare type DefinedUseQueryResult<TData = unknown, TError = unknown> = Omit<UseQueryResult<TData, TError>, 'data'> & {
|
|
19
|
-
data: TData;
|
|
20
|
-
};
|
|
21
|
-
export declare type UseInfiniteQueryResult<TData = unknown, TError = unknown> = InfiniteQueryObserverResult<TData, TError>;
|
|
22
|
-
export interface UseMutationOptions<TData = unknown, TError = unknown, TVariables = void, TContext = unknown> extends ContextOptions, Omit<MutationObserverOptions<TData, TError, TVariables, TContext>, '_defaulted' | 'variables'> {
|
|
23
|
-
}
|
|
24
|
-
export declare type UseMutateFunction<TData = unknown, TError = unknown, TVariables = void, TContext = unknown> = (...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>) => void;
|
|
25
|
-
export declare type UseMutateAsyncFunction<TData = unknown, TError = unknown, TVariables = void, TContext = unknown> = MutateFunction<TData, TError, TVariables, TContext>;
|
|
26
|
-
export declare type UseBaseMutationResult<TData = unknown, TError = unknown, TVariables = unknown, TContext = unknown> = Override<MutationObserverResult<TData, TError, TVariables, TContext>, {
|
|
27
|
-
mutate: UseMutateFunction<TData, TError, TVariables, TContext>;
|
|
28
|
-
}> & {
|
|
29
|
-
mutateAsync: UseMutateAsyncFunction<TData, TError, TVariables, TContext>;
|
|
30
|
-
};
|
|
31
|
-
export declare type UseMutationResult<TData = unknown, TError = unknown, TVariables = unknown, TContext = unknown> = UseBaseMutationResult<TData, TError, TVariables, TContext>;
|
|
32
|
-
declare type Override<A, B> = {
|
|
33
|
-
[K in keyof A]: K extends keyof B ? B[K] : A[K];
|
|
34
|
-
};
|
|
35
|
-
export {};
|
|
@@ -1,3 +0,0 @@
|
|
|
1
|
-
import { QueryKey, QueryObserver } from '@tanstack/query-core';
|
|
2
|
-
import { UseBaseQueryOptions } from './types';
|
|
3
|
-
export declare function useBaseQuery<TQueryFnData, TError, TData, TQueryData, TQueryKey extends QueryKey>(options: UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, Observer: typeof QueryObserver): import("@tanstack/query-core").QueryObserverResult<TData, TError>;
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
import { QueryFunction, QueryKey } from '@tanstack/query-core';
|
|
2
|
-
import { UseInfiniteQueryOptions, UseInfiniteQueryResult } from './types';
|
|
3
|
-
export declare function useInfiniteQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>): UseInfiniteQueryResult<TData, TError>;
|
|
4
|
-
export declare function useInfiniteQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, options?: Omit<UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>, 'queryKey'>): UseInfiniteQueryResult<TData, TError>;
|
|
5
|
-
export declare function useInfiniteQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: Omit<UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>, 'queryKey' | 'queryFn'>): UseInfiniteQueryResult<TData, TError>;
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import { QueryKey, QueryFilters } from '@tanstack/query-core';
|
|
2
|
-
import { ContextOptions } from './types';
|
|
3
|
-
interface Options extends ContextOptions {
|
|
4
|
-
}
|
|
5
|
-
export declare function useIsFetching(filters?: QueryFilters, options?: Options): number;
|
|
6
|
-
export declare function useIsFetching(queryKey?: QueryKey, filters?: QueryFilters, options?: Options): number;
|
|
7
|
-
export {};
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import { MutationKey, MutationFilters } from '@tanstack/query-core';
|
|
2
|
-
import { ContextOptions } from './types';
|
|
3
|
-
interface Options extends ContextOptions {
|
|
4
|
-
}
|
|
5
|
-
export declare function useIsMutating(filters?: MutationFilters, options?: Options): number;
|
|
6
|
-
export declare function useIsMutating(mutationKey?: MutationKey, filters?: Omit<MutationFilters, 'mutationKey'>, options?: Options): number;
|
|
7
|
-
export {};
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
import { MutationFunction, MutationKey } from '@tanstack/query-core';
|
|
2
|
-
import { UseMutationOptions, UseMutationResult } from './types';
|
|
3
|
-
export declare function useMutation<TData = unknown, TError = unknown, TVariables = void, TContext = unknown>(options: UseMutationOptions<TData, TError, TVariables, TContext>): UseMutationResult<TData, TError, TVariables, TContext>;
|
|
4
|
-
export declare function useMutation<TData = unknown, TError = unknown, TVariables = void, TContext = unknown>(mutationFn: MutationFunction<TData, TVariables>, options?: Omit<UseMutationOptions<TData, TError, TVariables, TContext>, 'mutationFn'>): UseMutationResult<TData, TError, TVariables, TContext>;
|
|
5
|
-
export declare function useMutation<TData = unknown, TError = unknown, TVariables = void, TContext = unknown>(mutationKey: MutationKey, options?: Omit<UseMutationOptions<TData, TError, TVariables, TContext>, 'mutationKey'>): UseMutationResult<TData, TError, TVariables, TContext>;
|
|
6
|
-
export declare function useMutation<TData = unknown, TError = unknown, TVariables = void, TContext = unknown>(mutationKey: MutationKey, mutationFn?: MutationFunction<TData, TVariables>, options?: Omit<UseMutationOptions<TData, TError, TVariables, TContext>, 'mutationKey' | 'mutationFn'>): UseMutationResult<TData, TError, TVariables, TContext>;
|
|
@@ -1,49 +0,0 @@
|
|
|
1
|
-
import { QueryKey, QueryFunction } from '@tanstack/query-core';
|
|
2
|
-
import { UseQueryOptions, UseQueryResult } from './types';
|
|
3
|
-
declare type UseQueryOptionsForUseQueries<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'context'>;
|
|
4
|
-
declare type MAXIMUM_DEPTH = 20;
|
|
5
|
-
declare type GetOptions<T> = T extends {
|
|
6
|
-
queryFnData: infer TQueryFnData;
|
|
7
|
-
error?: infer TError;
|
|
8
|
-
data: infer TData;
|
|
9
|
-
} ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData> : T extends {
|
|
10
|
-
queryFnData: infer TQueryFnData;
|
|
11
|
-
error?: infer TError;
|
|
12
|
-
} ? UseQueryOptionsForUseQueries<TQueryFnData, TError> : T extends {
|
|
13
|
-
data: infer TData;
|
|
14
|
-
error?: infer TError;
|
|
15
|
-
} ? UseQueryOptionsForUseQueries<unknown, TError, TData> : T extends [infer TQueryFnData, infer TError, infer TData] ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData> : T extends [infer TQueryFnData, infer TError] ? UseQueryOptionsForUseQueries<TQueryFnData, TError> : T extends [infer TQueryFnData] ? UseQueryOptionsForUseQueries<TQueryFnData> : T extends {
|
|
16
|
-
queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>;
|
|
17
|
-
select: (data: any) => infer TData;
|
|
18
|
-
} ? UseQueryOptionsForUseQueries<TQueryFnData, unknown, TData, TQueryKey> : T extends {
|
|
19
|
-
queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>;
|
|
20
|
-
} ? UseQueryOptionsForUseQueries<TQueryFnData, unknown, TQueryFnData, TQueryKey> : UseQueryOptionsForUseQueries;
|
|
21
|
-
declare type GetResults<T> = T extends {
|
|
22
|
-
queryFnData: any;
|
|
23
|
-
error?: infer TError;
|
|
24
|
-
data: infer TData;
|
|
25
|
-
} ? UseQueryResult<TData, TError> : T extends {
|
|
26
|
-
queryFnData: infer TQueryFnData;
|
|
27
|
-
error?: infer TError;
|
|
28
|
-
} ? UseQueryResult<TQueryFnData, TError> : T extends {
|
|
29
|
-
data: infer TData;
|
|
30
|
-
error?: infer TError;
|
|
31
|
-
} ? UseQueryResult<TData, TError> : T extends [any, infer TError, infer TData] ? UseQueryResult<TData, TError> : T extends [infer TQueryFnData, infer TError] ? UseQueryResult<TQueryFnData, TError> : T extends [infer TQueryFnData] ? UseQueryResult<TQueryFnData> : T extends {
|
|
32
|
-
queryFn?: QueryFunction<unknown, any>;
|
|
33
|
-
select: (data: any) => infer TData;
|
|
34
|
-
} ? UseQueryResult<TData> : T extends {
|
|
35
|
-
queryFn?: QueryFunction<infer TQueryFnData, any>;
|
|
36
|
-
} ? UseQueryResult<TQueryFnData> : UseQueryResult;
|
|
37
|
-
/**
|
|
38
|
-
* QueriesOptions reducer recursively unwraps function arguments to infer/enforce type param
|
|
39
|
-
*/
|
|
40
|
-
export declare type QueriesOptions<T extends any[], Result extends any[] = [], Depth extends ReadonlyArray<number> = []> = Depth['length'] extends MAXIMUM_DEPTH ? UseQueryOptionsForUseQueries[] : T extends [] ? [] : T extends [infer Head] ? [...Result, GetOptions<Head>] : T extends [infer Head, ...infer Tail] ? QueriesOptions<[...Tail], [...Result, GetOptions<Head>], [...Depth, 1]> : unknown[] extends T ? T : T extends UseQueryOptionsForUseQueries<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>[] ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptionsForUseQueries[];
|
|
41
|
-
/**
|
|
42
|
-
* QueriesResults reducer recursively maps type param to results
|
|
43
|
-
*/
|
|
44
|
-
export declare type QueriesResults<T extends any[], Result extends any[] = [], Depth extends ReadonlyArray<number> = []> = Depth['length'] extends MAXIMUM_DEPTH ? UseQueryResult[] : T extends [] ? [] : T extends [infer Head] ? [...Result, GetResults<Head>] : T extends [infer Head, ...infer Tail] ? QueriesResults<[...Tail], [...Result, GetResults<Head>], [...Depth, 1]> : T extends UseQueryOptionsForUseQueries<infer TQueryFnData, infer TError, infer TData, any>[] ? UseQueryResult<unknown extends TData ? TQueryFnData : TData, TError>[] : UseQueryResult[];
|
|
45
|
-
export declare function useQueries<T extends any[]>({ queries, context, }: {
|
|
46
|
-
queries: readonly [...QueriesOptions<T>];
|
|
47
|
-
context?: UseQueryOptions['context'];
|
|
48
|
-
}): QueriesResults<T>;
|
|
49
|
-
export {};
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
import { QueryFunction, QueryKey } from '@tanstack/query-core';
|
|
2
|
-
import { DefinedUseQueryResult, UseQueryOptions, UseQueryResult } from './types';
|
|
3
|
-
export declare function useQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'initialData'> & {
|
|
4
|
-
initialData?: () => undefined;
|
|
5
|
-
}): UseQueryResult<TData, TError>;
|
|
6
|
-
export declare function useQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'initialData'> & {
|
|
7
|
-
initialData: TQueryFnData | (() => TQueryFnData);
|
|
8
|
-
}): DefinedUseQueryResult<TData, TError>;
|
|
9
|
-
export declare function useQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>): UseQueryResult<TData, TError>;
|
|
10
|
-
export declare function useQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, options?: Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey' | 'initialData'> & {
|
|
11
|
-
initialData?: () => undefined;
|
|
12
|
-
}): UseQueryResult<TData, TError>;
|
|
13
|
-
export declare function useQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, options?: Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey' | 'initialData'> & {
|
|
14
|
-
initialData: TQueryFnData | (() => TQueryFnData);
|
|
15
|
-
}): DefinedUseQueryResult<TData, TError>;
|
|
16
|
-
export declare function useQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, options?: Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey'>): UseQueryResult<TData, TError>;
|
|
17
|
-
export declare function useQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey' | 'queryFn' | 'initialData'> & {
|
|
18
|
-
initialData?: () => undefined;
|
|
19
|
-
}): UseQueryResult<TData, TError>;
|
|
20
|
-
export declare function useQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey' | 'queryFn' | 'initialData'> & {
|
|
21
|
-
initialData: TQueryFnData | (() => TQueryFnData);
|
|
22
|
-
}): DefinedUseQueryResult<TData, TError>;
|
|
23
|
-
export declare function useQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(queryKey: TQueryKey, queryFn: QueryFunction<TQueryFnData, TQueryKey>, options?: Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'queryKey' | 'queryFn'>): UseQueryResult<TData, TError>;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export declare function shouldThrowError<T extends (...args: any[]) => boolean>(_useErrorBoundary: boolean | T | undefined, params: Parameters<T>): boolean;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
/// <reference types="jest" />
|
|
2
|
-
/// <reference types="node" />
|
|
3
|
-
import { MutationOptions, QueryClient, QueryClientConfig } from '@tanstack/query-core';
|
|
4
|
-
export declare function createQueryClient(config?: QueryClientConfig): QueryClient;
|
|
5
|
-
export declare function mockVisibilityState(value: DocumentVisibilityState): jest.SpyInstance<DocumentVisibilityState, []>;
|
|
6
|
-
export declare function mockNavigatorOnLine(value: boolean): jest.SpyInstance<boolean, []>;
|
|
7
|
-
export declare const mockLogger: {
|
|
8
|
-
log: jest.Mock<any, any>;
|
|
9
|
-
warn: jest.Mock<any, any>;
|
|
10
|
-
error: jest.Mock<any, any>;
|
|
11
|
-
};
|
|
12
|
-
export declare function queryKey(): Array<string>;
|
|
13
|
-
export declare function sleep(timeout: number): Promise<void>;
|
|
14
|
-
export declare function setActTimeout(fn: () => void, ms?: number): NodeJS.Timeout;
|
|
15
|
-
/**
|
|
16
|
-
* Assert the parameter is of a specific type.
|
|
17
|
-
*/
|
|
18
|
-
export declare const expectType: <T>(_: T) => void;
|
|
19
|
-
/**
|
|
20
|
-
* Assert the parameter is not typed as `any`
|
|
21
|
-
*/
|
|
22
|
-
export declare const expectTypeNotAny: <T>(_: 0 extends 1 & T ? never : T) => void;
|
|
23
|
-
export declare const executeMutation: (queryClient: QueryClient, options: MutationOptions<any, any, any, any>) => Promise<unknown>;
|
|
24
|
-
export declare function setIsServer(isServer: boolean): () => void;
|