@tanstack/solid-query 5.71.8 → 5.71.9

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/index.d.cts CHANGED
@@ -1,4 +1,4 @@
1
- import { QueryClient as QueryClient$1, QueryClientConfig as QueryClientConfig$1, DefaultError, DefaultOptions as DefaultOptions$1, OmitKeyof, QueryKey, QueryObserverOptions as QueryObserverOptions$1, InfiniteQueryObserverOptions as InfiniteQueryObserverOptions$1, QueryObserverResult, DefinedQueryObserverResult, DefinedInfiniteQueryObserverResult, InfiniteQueryObserverResult, MutationObserverOptions, Override, MutationObserverResult, MutateFunction, DataTag, QueryFilters, InfiniteData, MutationFilters, MutationState, Mutation, QueryFunction, ThrowOnError, QueriesPlaceholderDataFunction } from '@tanstack/query-core';
1
+ import { DefaultError, QueryKey, OmitKeyof, InfiniteQueryObserverOptions as InfiniteQueryObserverOptions$1, QueryClient as QueryClient$1, QueryClientConfig as QueryClientConfig$1, DefaultOptions as DefaultOptions$1, QueryObserverOptions as QueryObserverOptions$1, DefinedInfiniteQueryObserverResult, InfiniteQueryObserverResult, QueryObserverResult, DefinedQueryObserverResult, MutationObserverOptions, MutateFunction, Override, MutationObserverResult, DataTag, InfiniteData, QueryFunction, ThrowOnError, QueriesPlaceholderDataFunction, QueryFilters, MutationFilters, MutationState, Mutation } from '@tanstack/query-core';
2
2
  export * from '@tanstack/query-core';
3
3
  import * as solid_js from 'solid-js';
4
4
  import { Accessor, JSX } from 'solid-js';
@@ -31,7 +31,7 @@ declare class QueryClient extends QueryClient$1 {
31
31
  constructor(config?: QueryClientConfig);
32
32
  }
33
33
 
34
- interface CreateBaseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends OmitKeyof<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, 'suspense'> {
34
+ interface UseBaseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends OmitKeyof<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, 'suspense'> {
35
35
  /**
36
36
  * Only applicable while rendering queries on the server with streaming.
37
37
  * Set `deferStream` to `true` to wait for the query to resolve on the server before flushing the stream.
@@ -41,18 +41,18 @@ interface CreateBaseQueryOptions<TQueryFnData = unknown, TError = DefaultError,
41
41
  deferStream?: boolean;
42
42
  /**
43
43
  * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
44
- * The `data` property on createQuery is a SolidJS resource and will automatically suspend when the data is loading.
44
+ * The `data` property on useQuery is a SolidJS resource and will automatically suspend when the data is loading.
45
45
  * Setting `suspense` to `false` will be a no-op.
46
46
  */
47
47
  suspense?: boolean;
48
48
  }
49
- interface SolidQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends CreateBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> {
49
+ interface SolidQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> {
50
50
  }
51
- type CreateQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = Accessor<SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey>>;
52
- type CreateBaseQueryResult<TData = unknown, TError = DefaultError> = QueryObserverResult<TData, TError>;
53
- type CreateQueryResult<TData = unknown, TError = DefaultError> = CreateBaseQueryResult<TData, TError>;
54
- type DefinedCreateBaseQueryResult<TData = unknown, TError = DefaultError> = DefinedQueryObserverResult<TData, TError>;
55
- type DefinedCreateQueryResult<TData = unknown, TError = DefaultError> = DefinedCreateBaseQueryResult<TData, TError>;
51
+ type UseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = Accessor<SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey>>;
52
+ type UseBaseQueryResult<TData = unknown, TError = DefaultError> = QueryObserverResult<TData, TError>;
53
+ type UseQueryResult<TData = unknown, TError = DefaultError> = UseBaseQueryResult<TData, TError>;
54
+ type DefinedUseBaseQueryResult<TData = unknown, TError = DefaultError> = DefinedQueryObserverResult<TData, TError>;
55
+ type DefinedUseQueryResult<TData = unknown, TError = DefaultError> = DefinedUseBaseQueryResult<TData, TError>;
56
56
  interface SolidInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> extends OmitKeyof<InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>, 'queryKey' | 'suspense'> {
57
57
  queryKey: TQueryKey;
58
58
  /**
@@ -64,25 +64,25 @@ interface SolidInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultErro
64
64
  deferStream?: boolean;
65
65
  /**
66
66
  * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
67
- * The `data` property on createInfiniteQuery is a SolidJS resource and will automatically suspend when the data is loading.
67
+ * The `data` property on useInfiniteQuery is a SolidJS resource and will automatically suspend when the data is loading.
68
68
  * Setting `suspense` to `false` will be a no-op.
69
69
  */
70
70
  suspense?: boolean;
71
71
  }
72
- type CreateInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = Accessor<SolidInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, TPageParam>>;
73
- type CreateInfiniteQueryResult<TData = unknown, TError = DefaultError> = InfiniteQueryObserverResult<TData, TError>;
74
- type DefinedCreateInfiniteQueryResult<TData = unknown, TError = DefaultError> = DefinedInfiniteQueryObserverResult<TData, TError>;
72
+ type UseInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = Accessor<SolidInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, TPageParam>>;
73
+ type UseInfiniteQueryResult<TData = unknown, TError = DefaultError> = InfiniteQueryObserverResult<TData, TError>;
74
+ type DefinedUseInfiniteQueryResult<TData = unknown, TError = DefaultError> = DefinedInfiniteQueryObserverResult<TData, TError>;
75
75
  interface SolidMutationOptions<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> extends OmitKeyof<MutationObserverOptions<TData, TError, TVariables, TContext>, '_defaulted'> {
76
76
  }
77
- type CreateMutationOptions<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> = Accessor<SolidMutationOptions<TData, TError, TVariables, TContext>>;
78
- type CreateMutateFunction<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> = (...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>) => void;
79
- type CreateMutateAsyncFunction<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> = MutateFunction<TData, TError, TVariables, TContext>;
80
- type CreateBaseMutationResult<TData = unknown, TError = DefaultError, TVariables = unknown, TContext = unknown> = Override<MutationObserverResult<TData, TError, TVariables, TContext>, {
81
- mutate: CreateMutateFunction<TData, TError, TVariables, TContext>;
77
+ type UseMutationOptions<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> = Accessor<SolidMutationOptions<TData, TError, TVariables, TContext>>;
78
+ type UseMutateFunction<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> = (...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>) => void;
79
+ type UseMutateAsyncFunction<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> = MutateFunction<TData, TError, TVariables, TContext>;
80
+ type UseBaseMutationResult<TData = unknown, TError = DefaultError, TVariables = unknown, TContext = unknown> = Override<MutationObserverResult<TData, TError, TVariables, TContext>, {
81
+ mutate: UseMutateFunction<TData, TError, TVariables, TContext>;
82
82
  }> & {
83
- mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TContext>;
83
+ mutateAsync: UseMutateAsyncFunction<TData, TError, TVariables, TContext>;
84
84
  };
85
- type CreateMutationResult<TData = unknown, TError = DefaultError, TVariables = unknown, TContext = unknown> = CreateBaseMutationResult<TData, TError, TVariables, TContext>;
85
+ type UseMutationResult<TData = unknown, TError = DefaultError, TVariables = unknown, TContext = unknown> = UseBaseMutationResult<TData, TError, TVariables, TContext>;
86
86
 
87
87
  type UndefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = Accessor<SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
88
88
  initialData?: undefined;
@@ -97,18 +97,8 @@ declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TDa
97
97
  queryKey: DataTag<TQueryKey, TQueryFnData>;
98
98
  };
99
99
 
100
- declare function createQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: () => QueryClient): CreateQueryResult<TData, TError>;
101
- declare function createQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: () => QueryClient): DefinedCreateQueryResult<TData, TError>;
102
-
103
- declare const QueryClientContext: solid_js.Context<(() => QueryClient) | undefined>;
104
- declare const useQueryClient: (queryClient?: QueryClient) => QueryClient;
105
- type QueryClientProviderProps = {
106
- client: QueryClient;
107
- children?: JSX.Element;
108
- };
109
- declare const QueryClientProvider: (props: QueryClientProviderProps) => JSX.Element;
110
-
111
- declare function useIsFetching(filters?: Accessor<QueryFilters>, queryClient?: Accessor<QueryClient>): Accessor<number>;
100
+ declare function useQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: () => QueryClient): UseQueryResult<TData, TError>;
101
+ declare function useQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: () => QueryClient): DefinedUseQueryResult<TData, TError>;
112
102
 
113
103
  type UndefinedInitialDataInfiniteOptions<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = Accessor<SolidInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, TPageParam> & {
114
104
  initialData?: undefined;
@@ -124,24 +114,16 @@ declare function infiniteQueryOptions<TQueryFnData, TError = DefaultError, TData
124
114
  queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>>;
125
115
  };
126
116
 
127
- declare function createInfiniteQuery<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, queryClient?: Accessor<QueryClient>): DefinedCreateInfiniteQueryResult<TData, TError>;
128
- declare function createInfiniteQuery<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, queryClient?: Accessor<QueryClient>): CreateInfiniteQueryResult<TData, TError>;
117
+ declare function useInfiniteQuery<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, queryClient?: Accessor<QueryClient>): DefinedUseInfiniteQueryResult<TData, TError>;
118
+ declare function useInfiniteQuery<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, queryClient?: Accessor<QueryClient>): UseInfiniteQueryResult<TData, TError>;
129
119
 
130
- declare function createMutation<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown>(options: CreateMutationOptions<TData, TError, TVariables, TContext>, queryClient?: Accessor<QueryClient>): CreateMutationResult<TData, TError, TVariables, TContext>;
120
+ declare function useMutation<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown>(options: UseMutationOptions<TData, TError, TVariables, TContext>, queryClient?: Accessor<QueryClient>): UseMutationResult<TData, TError, TVariables, TContext>;
131
121
 
132
- declare function useIsMutating(filters?: Accessor<MutationFilters>, queryClient?: Accessor<QueryClient>): Accessor<number>;
133
-
134
- type MutationStateOptions<TResult = MutationState> = {
135
- filters?: MutationFilters;
136
- select?: (mutation: Mutation) => TResult;
137
- };
138
- declare function useMutationState<TResult = MutationState>(options?: Accessor<MutationStateOptions<TResult>>, queryClient?: Accessor<QueryClient>): Accessor<Array<TResult>>;
139
-
140
- type CreateQueryOptionsForCreateQueries<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = OmitKeyof<SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'placeholderData' | 'suspense'> & {
122
+ type UseQueryOptionsForUseQueries<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = OmitKeyof<SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'placeholderData' | 'suspense'> & {
141
123
  placeholderData?: TQueryFnData | QueriesPlaceholderDataFunction<TQueryFnData>;
142
124
  /**
143
125
  * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
144
- * The `data` property on createQueries is a plain object and not a SolidJS Resource.
126
+ * The `data` property on useQueries is a plain object and not a SolidJS Resource.
145
127
  * It will not suspend when the data is loading.
146
128
  * Setting `suspense` to `true` will be a no-op.
147
129
  */
@@ -153,36 +135,36 @@ type GetOptions<T> = T extends {
153
135
  queryFnData: infer TQueryFnData;
154
136
  error?: infer TError;
155
137
  data: infer TData;
156
- } ? CreateQueryOptionsForCreateQueries<TQueryFnData, TError, TData> : T extends {
138
+ } ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData> : T extends {
157
139
  queryFnData: infer TQueryFnData;
158
140
  error?: infer TError;
159
- } ? CreateQueryOptionsForCreateQueries<TQueryFnData, TError> : T extends {
141
+ } ? UseQueryOptionsForUseQueries<TQueryFnData, TError> : T extends {
160
142
  data: infer TData;
161
143
  error?: infer TError;
162
- } ? CreateQueryOptionsForCreateQueries<unknown, TError, TData> : T extends [infer TQueryFnData, infer TError, infer TData] ? CreateQueryOptionsForCreateQueries<TQueryFnData, TError, TData> : T extends [infer TQueryFnData, infer TError] ? CreateQueryOptionsForCreateQueries<TQueryFnData, TError> : T extends [infer TQueryFnData] ? CreateQueryOptionsForCreateQueries<TQueryFnData> : T extends {
144
+ } ? 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 {
163
145
  queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey> | SkipTokenForUseQueries;
164
146
  select?: (data: any) => infer TData;
165
147
  throwOnError?: ThrowOnError<any, infer TError, any, any>;
166
- } ? CreateQueryOptionsForCreateQueries<TQueryFnData, unknown extends TError ? DefaultError : TError, unknown extends TData ? TQueryFnData : TData, TQueryKey> : CreateQueryOptionsForCreateQueries;
148
+ } ? UseQueryOptionsForUseQueries<TQueryFnData, unknown extends TError ? DefaultError : TError, unknown extends TData ? TQueryFnData : TData, TQueryKey> : UseQueryOptionsForUseQueries;
167
149
  type GetResults<T> = T extends {
168
150
  queryFnData: any;
169
151
  error?: infer TError;
170
152
  data: infer TData;
171
- } ? CreateQueryResult<TData, TError> : T extends {
153
+ } ? UseQueryResult<TData, TError> : T extends {
172
154
  queryFnData: infer TQueryFnData;
173
155
  error?: infer TError;
174
- } ? CreateQueryResult<TQueryFnData, TError> : T extends {
156
+ } ? UseQueryResult<TQueryFnData, TError> : T extends {
175
157
  data: infer TData;
176
158
  error?: infer TError;
177
- } ? CreateQueryResult<TData, TError> : T extends [any, infer TError, infer TData] ? CreateQueryResult<TData, TError> : T extends [infer TQueryFnData, infer TError] ? CreateQueryResult<TQueryFnData, TError> : T extends [infer TQueryFnData] ? CreateQueryResult<TQueryFnData> : T extends {
159
+ } ? 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 {
178
160
  queryFn?: QueryFunction<infer TQueryFnData, any> | SkipTokenForUseQueries;
179
161
  select?: (data: any) => infer TData;
180
162
  throwOnError?: ThrowOnError<any, infer TError, any, any>;
181
- } ? CreateQueryResult<unknown extends TData ? TQueryFnData : TData, unknown extends TError ? DefaultError : TError> : CreateQueryResult;
163
+ } ? UseQueryResult<unknown extends TData ? TQueryFnData : TData, unknown extends TError ? DefaultError : TError> : UseQueryResult;
182
164
  /**
183
165
  * QueriesOptions reducer recursively unwraps function arguments to infer/enforce type param
184
166
  */
185
- type QueriesOptions<T extends Array<any>, TResult extends Array<any> = [], TDepth extends ReadonlyArray<number> = []> = TDepth['length'] extends MAXIMUM_DEPTH ? Array<CreateQueryOptionsForCreateQueries> : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetOptions<Head>] : T extends [infer Head, ...infer Tail] ? QueriesOptions<[
167
+ type QueriesOptions<T extends Array<any>, TResult extends Array<any> = [], TDepth extends ReadonlyArray<number> = []> = TDepth['length'] extends MAXIMUM_DEPTH ? Array<UseQueryOptionsForUseQueries> : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetOptions<Head>] : T extends [infer Head, ...infer Tail] ? QueriesOptions<[
186
168
  ...Tail
187
169
  ], [
188
170
  ...TResult,
@@ -190,11 +172,11 @@ type QueriesOptions<T extends Array<any>, TResult extends Array<any> = [], TDept
190
172
  ], [
191
173
  ...TDepth,
192
174
  1
193
- ]> : ReadonlyArray<unknown> extends T ? T : T extends Array<CreateQueryOptionsForCreateQueries<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>> ? Array<CreateQueryOptionsForCreateQueries<TQueryFnData, TError, TData, TQueryKey>> : Array<CreateQueryOptionsForCreateQueries>;
175
+ ]> : ReadonlyArray<unknown> extends T ? T : T extends Array<UseQueryOptionsForUseQueries<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>> ? Array<UseQueryOptionsForUseQueries<TQueryFnData, TError, TData, TQueryKey>> : Array<UseQueryOptionsForUseQueries>;
194
176
  /**
195
177
  * QueriesResults reducer recursively maps type param to results
196
178
  */
197
- type QueriesResults<T extends Array<any>, TResult extends Array<any> = [], TDepth extends ReadonlyArray<number> = []> = TDepth['length'] extends MAXIMUM_DEPTH ? Array<CreateQueryResult> : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetResults<Head>] : T extends [infer Head, ...infer Tail] ? QueriesResults<[
179
+ type QueriesResults<T extends Array<any>, TResult extends Array<any> = [], TDepth extends ReadonlyArray<number> = []> = TDepth['length'] extends MAXIMUM_DEPTH ? Array<UseQueryResult> : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetResults<Head>] : T extends [infer Head, ...infer Tail] ? QueriesResults<[
198
180
  ...Tail
199
181
  ], [
200
182
  ...TResult,
@@ -205,14 +187,73 @@ type QueriesResults<T extends Array<any>, TResult extends Array<any> = [], TDept
205
187
  ]> : {
206
188
  [K in keyof T]: GetResults<T[K]>;
207
189
  };
208
- declare function createQueries<T extends Array<any>, TCombinedResult extends QueriesResults<T> = QueriesResults<T>>(queriesOptions: Accessor<{
190
+ declare function useQueries<T extends Array<any>, TCombinedResult extends QueriesResults<T> = QueriesResults<T>>(queriesOptions: Accessor<{
209
191
  queries: readonly [...QueriesOptions<T>] | readonly [...{
210
192
  [K in keyof T]: GetOptions<T[K]>;
211
193
  }];
212
194
  combine?: (result: QueriesResults<T>) => TCombinedResult;
213
195
  }>, queryClient?: Accessor<QueryClient>): TCombinedResult;
214
196
 
197
+ declare const QueryClientContext: solid_js.Context<(() => QueryClient) | undefined>;
198
+ declare const useQueryClient: (queryClient?: QueryClient) => QueryClient;
199
+ type QueryClientProviderProps = {
200
+ client: QueryClient;
201
+ children?: JSX.Element;
202
+ };
203
+ declare const QueryClientProvider: (props: QueryClientProviderProps) => JSX.Element;
204
+
205
+ declare function useIsFetching(filters?: Accessor<QueryFilters>, queryClient?: Accessor<QueryClient>): Accessor<number>;
206
+
207
+ declare function useIsMutating(filters?: Accessor<MutationFilters>, queryClient?: Accessor<QueryClient>): Accessor<number>;
208
+
209
+ type MutationStateOptions<TResult = MutationState> = {
210
+ filters?: MutationFilters;
211
+ select?: (mutation: Mutation) => TResult;
212
+ };
213
+ declare function useMutationState<TResult = MutationState>(options?: Accessor<MutationStateOptions<TResult>>, queryClient?: Accessor<QueryClient>): Accessor<Array<TResult>>;
214
+
215
215
  declare const useIsRestoring: () => Accessor<boolean>;
216
216
  declare const IsRestoringProvider: solid_js.ContextProviderComponent<Accessor<boolean>>;
217
217
 
218
- export { type CreateBaseMutationResult, type CreateBaseQueryOptions, type CreateBaseQueryResult, type CreateInfiniteQueryOptions, type CreateInfiniteQueryResult, type CreateMutateAsyncFunction, type CreateMutateFunction, type CreateMutationOptions, type CreateMutationResult, type CreateQueryOptions, type CreateQueryResult, type DefaultOptions, type DefinedCreateBaseQueryResult, type DefinedCreateInfiniteQueryResult, type DefinedCreateQueryResult, type DefinedInitialDataInfiniteOptions, type DefinedInitialDataOptions, type InfiniteQueryObserverOptions, IsRestoringProvider, QueryClient, type QueryClientConfig, QueryClientContext, QueryClientProvider, type QueryClientProviderProps, type QueryObserverOptions, type SolidInfiniteQueryOptions, type SolidMutationOptions, type SolidQueryOptions, type UndefinedInitialDataInfiniteOptions, type UndefinedInitialDataOptions, createInfiniteQuery, createMutation, createQueries, createQuery, infiniteQueryOptions, queryOptions, useIsFetching, useIsMutating, useIsRestoring, useMutationState, useQueryClient };
218
+ /** @deprecated Use UseQueryOptions instead */
219
+ type CreateQueryOptions = UseQueryOptions;
220
+ /** @deprecated Use UseBaseQueryResult instead */
221
+ type CreateBaseQueryResult = UseBaseQueryResult;
222
+ /** @deprecated Use UseQueryResult instead */
223
+ type CreateQueryResult = UseQueryResult;
224
+ /** @deprecated Use DefinedUseBaseQueryResult instead */
225
+ type DefinedCreateBaseQueryResult = DefinedUseBaseQueryResult;
226
+ /** @deprecated Use DefinedUseQueryResult instead */
227
+ type DefinedCreateQueryResult = DefinedUseQueryResult;
228
+ /** @deprecated Use UseInfiniteQueryOptions instead */
229
+ type CreateInfiniteQueryOptions = UseInfiniteQueryOptions;
230
+ /** @deprecated Use UseInfiniteQueryResult instead */
231
+ type CreateInfiniteQueryResult = UseInfiniteQueryResult;
232
+ /** @deprecated Use DefinedUseInfiniteQueryResult instead */
233
+ type DefinedCreateInfiniteQueryResult = DefinedUseInfiniteQueryResult;
234
+ /** @deprecated Use UseMutationOptions instead */
235
+ type CreateMutationOptions = UseMutationOptions;
236
+ /** @deprecated Use UseMutateFunction instead */
237
+ type CreateMutateFunction = UseMutateFunction;
238
+ /** @deprecated Use UseMutateAsyncFunction instead */
239
+ type CreateMutateAsyncFunction = UseMutateAsyncFunction;
240
+ /** @deprecated Use UseBaseMutationResult instead */
241
+ type CreateBaseMutationResult = UseBaseMutationResult;
242
+ /** @deprecated Use UseMutationResult instead */
243
+ type CreateMutationResult = UseMutationResult;
244
+ /** @deprecated Use UseBaseQueryOptions instead */
245
+ type CreateBaseQueryOptions = UseBaseQueryOptions;
246
+
247
+ /** @deprecated Use useQuery instead */
248
+ declare const createQuery: typeof useQuery;
249
+
250
+ /** @deprecated Use useInfiniteQuery instead */
251
+ declare const createInfiniteQuery: typeof useInfiniteQuery;
252
+
253
+ /** @deprecated Use useMutation instead */
254
+ declare const createMutation: typeof useMutation;
255
+
256
+ /** @deprecated Use useQueries instead */
257
+ declare const createQueries: typeof useQueries;
258
+
259
+ export { type CreateBaseMutationResult, type CreateBaseQueryOptions, type CreateBaseQueryResult, type CreateInfiniteQueryOptions, type CreateInfiniteQueryResult, type CreateMutateAsyncFunction, type CreateMutateFunction, type CreateMutationOptions, type CreateMutationResult, type CreateQueryOptions, type CreateQueryResult, type DefaultOptions, type DefinedCreateBaseQueryResult, type DefinedCreateInfiniteQueryResult, type DefinedCreateQueryResult, type DefinedInitialDataInfiniteOptions, type DefinedInitialDataOptions, type DefinedUseBaseQueryResult, type DefinedUseInfiniteQueryResult, type DefinedUseQueryResult, type InfiniteQueryObserverOptions, IsRestoringProvider, QueryClient, type QueryClientConfig, QueryClientContext, QueryClientProvider, type QueryClientProviderProps, type QueryObserverOptions, type SolidInfiniteQueryOptions, type SolidMutationOptions, type SolidQueryOptions, type UndefinedInitialDataInfiniteOptions, type UndefinedInitialDataOptions, type UseBaseMutationResult, type UseBaseQueryOptions, type UseBaseQueryResult, type UseInfiniteQueryOptions, type UseInfiniteQueryResult, type UseMutateAsyncFunction, type UseMutateFunction, type UseMutationOptions, type UseMutationResult, type UseQueryOptions, type UseQueryResult, createInfiniteQuery, createMutation, createQueries, createQuery, infiniteQueryOptions, queryOptions, useInfiniteQuery, useIsFetching, useIsMutating, useIsRestoring, useMutation, useMutationState, useQueries, useQuery, useQueryClient };
package/build/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { QueryClient as QueryClient$1, QueryClientConfig as QueryClientConfig$1, DefaultError, DefaultOptions as DefaultOptions$1, OmitKeyof, QueryKey, QueryObserverOptions as QueryObserverOptions$1, InfiniteQueryObserverOptions as InfiniteQueryObserverOptions$1, QueryObserverResult, DefinedQueryObserverResult, DefinedInfiniteQueryObserverResult, InfiniteQueryObserverResult, MutationObserverOptions, Override, MutationObserverResult, MutateFunction, DataTag, QueryFilters, InfiniteData, MutationFilters, MutationState, Mutation, QueryFunction, ThrowOnError, QueriesPlaceholderDataFunction } from '@tanstack/query-core';
1
+ import { DefaultError, QueryKey, OmitKeyof, InfiniteQueryObserverOptions as InfiniteQueryObserverOptions$1, QueryClient as QueryClient$1, QueryClientConfig as QueryClientConfig$1, DefaultOptions as DefaultOptions$1, QueryObserverOptions as QueryObserverOptions$1, DefinedInfiniteQueryObserverResult, InfiniteQueryObserverResult, QueryObserverResult, DefinedQueryObserverResult, MutationObserverOptions, MutateFunction, Override, MutationObserverResult, DataTag, InfiniteData, QueryFunction, ThrowOnError, QueriesPlaceholderDataFunction, QueryFilters, MutationFilters, MutationState, Mutation } from '@tanstack/query-core';
2
2
  export * from '@tanstack/query-core';
3
3
  import * as solid_js from 'solid-js';
4
4
  import { Accessor, JSX } from 'solid-js';
@@ -31,7 +31,7 @@ declare class QueryClient extends QueryClient$1 {
31
31
  constructor(config?: QueryClientConfig);
32
32
  }
33
33
 
34
- interface CreateBaseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends OmitKeyof<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, 'suspense'> {
34
+ interface UseBaseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends OmitKeyof<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>, 'suspense'> {
35
35
  /**
36
36
  * Only applicable while rendering queries on the server with streaming.
37
37
  * Set `deferStream` to `true` to wait for the query to resolve on the server before flushing the stream.
@@ -41,18 +41,18 @@ interface CreateBaseQueryOptions<TQueryFnData = unknown, TError = DefaultError,
41
41
  deferStream?: boolean;
42
42
  /**
43
43
  * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
44
- * The `data` property on createQuery is a SolidJS resource and will automatically suspend when the data is loading.
44
+ * The `data` property on useQuery is a SolidJS resource and will automatically suspend when the data is loading.
45
45
  * Setting `suspense` to `false` will be a no-op.
46
46
  */
47
47
  suspense?: boolean;
48
48
  }
49
- interface SolidQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends CreateBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> {
49
+ interface SolidQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> {
50
50
  }
51
- type CreateQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = Accessor<SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey>>;
52
- type CreateBaseQueryResult<TData = unknown, TError = DefaultError> = QueryObserverResult<TData, TError>;
53
- type CreateQueryResult<TData = unknown, TError = DefaultError> = CreateBaseQueryResult<TData, TError>;
54
- type DefinedCreateBaseQueryResult<TData = unknown, TError = DefaultError> = DefinedQueryObserverResult<TData, TError>;
55
- type DefinedCreateQueryResult<TData = unknown, TError = DefaultError> = DefinedCreateBaseQueryResult<TData, TError>;
51
+ type UseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = Accessor<SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey>>;
52
+ type UseBaseQueryResult<TData = unknown, TError = DefaultError> = QueryObserverResult<TData, TError>;
53
+ type UseQueryResult<TData = unknown, TError = DefaultError> = UseBaseQueryResult<TData, TError>;
54
+ type DefinedUseBaseQueryResult<TData = unknown, TError = DefaultError> = DefinedQueryObserverResult<TData, TError>;
55
+ type DefinedUseQueryResult<TData = unknown, TError = DefaultError> = DefinedUseBaseQueryResult<TData, TError>;
56
56
  interface SolidInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> extends OmitKeyof<InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>, 'queryKey' | 'suspense'> {
57
57
  queryKey: TQueryKey;
58
58
  /**
@@ -64,25 +64,25 @@ interface SolidInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultErro
64
64
  deferStream?: boolean;
65
65
  /**
66
66
  * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
67
- * The `data` property on createInfiniteQuery is a SolidJS resource and will automatically suspend when the data is loading.
67
+ * The `data` property on useInfiniteQuery is a SolidJS resource and will automatically suspend when the data is loading.
68
68
  * Setting `suspense` to `false` will be a no-op.
69
69
  */
70
70
  suspense?: boolean;
71
71
  }
72
- type CreateInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = Accessor<SolidInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, TPageParam>>;
73
- type CreateInfiniteQueryResult<TData = unknown, TError = DefaultError> = InfiniteQueryObserverResult<TData, TError>;
74
- type DefinedCreateInfiniteQueryResult<TData = unknown, TError = DefaultError> = DefinedInfiniteQueryObserverResult<TData, TError>;
72
+ type UseInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = Accessor<SolidInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, TPageParam>>;
73
+ type UseInfiniteQueryResult<TData = unknown, TError = DefaultError> = InfiniteQueryObserverResult<TData, TError>;
74
+ type DefinedUseInfiniteQueryResult<TData = unknown, TError = DefaultError> = DefinedInfiniteQueryObserverResult<TData, TError>;
75
75
  interface SolidMutationOptions<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> extends OmitKeyof<MutationObserverOptions<TData, TError, TVariables, TContext>, '_defaulted'> {
76
76
  }
77
- type CreateMutationOptions<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> = Accessor<SolidMutationOptions<TData, TError, TVariables, TContext>>;
78
- type CreateMutateFunction<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> = (...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>) => void;
79
- type CreateMutateAsyncFunction<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> = MutateFunction<TData, TError, TVariables, TContext>;
80
- type CreateBaseMutationResult<TData = unknown, TError = DefaultError, TVariables = unknown, TContext = unknown> = Override<MutationObserverResult<TData, TError, TVariables, TContext>, {
81
- mutate: CreateMutateFunction<TData, TError, TVariables, TContext>;
77
+ type UseMutationOptions<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> = Accessor<SolidMutationOptions<TData, TError, TVariables, TContext>>;
78
+ type UseMutateFunction<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> = (...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>) => void;
79
+ type UseMutateAsyncFunction<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> = MutateFunction<TData, TError, TVariables, TContext>;
80
+ type UseBaseMutationResult<TData = unknown, TError = DefaultError, TVariables = unknown, TContext = unknown> = Override<MutationObserverResult<TData, TError, TVariables, TContext>, {
81
+ mutate: UseMutateFunction<TData, TError, TVariables, TContext>;
82
82
  }> & {
83
- mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TContext>;
83
+ mutateAsync: UseMutateAsyncFunction<TData, TError, TVariables, TContext>;
84
84
  };
85
- type CreateMutationResult<TData = unknown, TError = DefaultError, TVariables = unknown, TContext = unknown> = CreateBaseMutationResult<TData, TError, TVariables, TContext>;
85
+ type UseMutationResult<TData = unknown, TError = DefaultError, TVariables = unknown, TContext = unknown> = UseBaseMutationResult<TData, TError, TVariables, TContext>;
86
86
 
87
87
  type UndefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = Accessor<SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
88
88
  initialData?: undefined;
@@ -97,18 +97,8 @@ declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TDa
97
97
  queryKey: DataTag<TQueryKey, TQueryFnData>;
98
98
  };
99
99
 
100
- declare function createQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: () => QueryClient): CreateQueryResult<TData, TError>;
101
- declare function createQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: () => QueryClient): DefinedCreateQueryResult<TData, TError>;
102
-
103
- declare const QueryClientContext: solid_js.Context<(() => QueryClient) | undefined>;
104
- declare const useQueryClient: (queryClient?: QueryClient) => QueryClient;
105
- type QueryClientProviderProps = {
106
- client: QueryClient;
107
- children?: JSX.Element;
108
- };
109
- declare const QueryClientProvider: (props: QueryClientProviderProps) => JSX.Element;
110
-
111
- declare function useIsFetching(filters?: Accessor<QueryFilters>, queryClient?: Accessor<QueryClient>): Accessor<number>;
100
+ declare function useQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: () => QueryClient): UseQueryResult<TData, TError>;
101
+ declare function useQuery<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey>(options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: () => QueryClient): DefinedUseQueryResult<TData, TError>;
112
102
 
113
103
  type UndefinedInitialDataInfiniteOptions<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> = Accessor<SolidInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey, TPageParam> & {
114
104
  initialData?: undefined;
@@ -124,24 +114,16 @@ declare function infiniteQueryOptions<TQueryFnData, TError = DefaultError, TData
124
114
  queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>>;
125
115
  };
126
116
 
127
- declare function createInfiniteQuery<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, queryClient?: Accessor<QueryClient>): DefinedCreateInfiniteQueryResult<TData, TError>;
128
- declare function createInfiniteQuery<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, queryClient?: Accessor<QueryClient>): CreateInfiniteQueryResult<TData, TError>;
117
+ declare function useInfiniteQuery<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, queryClient?: Accessor<QueryClient>): DefinedUseInfiniteQueryResult<TData, TError>;
118
+ declare function useInfiniteQuery<TQueryFnData, TError = DefaultError, TData = InfiniteData<TQueryFnData>, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown>(options: UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, queryClient?: Accessor<QueryClient>): UseInfiniteQueryResult<TData, TError>;
129
119
 
130
- declare function createMutation<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown>(options: CreateMutationOptions<TData, TError, TVariables, TContext>, queryClient?: Accessor<QueryClient>): CreateMutationResult<TData, TError, TVariables, TContext>;
120
+ declare function useMutation<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown>(options: UseMutationOptions<TData, TError, TVariables, TContext>, queryClient?: Accessor<QueryClient>): UseMutationResult<TData, TError, TVariables, TContext>;
131
121
 
132
- declare function useIsMutating(filters?: Accessor<MutationFilters>, queryClient?: Accessor<QueryClient>): Accessor<number>;
133
-
134
- type MutationStateOptions<TResult = MutationState> = {
135
- filters?: MutationFilters;
136
- select?: (mutation: Mutation) => TResult;
137
- };
138
- declare function useMutationState<TResult = MutationState>(options?: Accessor<MutationStateOptions<TResult>>, queryClient?: Accessor<QueryClient>): Accessor<Array<TResult>>;
139
-
140
- type CreateQueryOptionsForCreateQueries<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = OmitKeyof<SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'placeholderData' | 'suspense'> & {
122
+ type UseQueryOptionsForUseQueries<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = OmitKeyof<SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'placeholderData' | 'suspense'> & {
141
123
  placeholderData?: TQueryFnData | QueriesPlaceholderDataFunction<TQueryFnData>;
142
124
  /**
143
125
  * @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
144
- * The `data` property on createQueries is a plain object and not a SolidJS Resource.
126
+ * The `data` property on useQueries is a plain object and not a SolidJS Resource.
145
127
  * It will not suspend when the data is loading.
146
128
  * Setting `suspense` to `true` will be a no-op.
147
129
  */
@@ -153,36 +135,36 @@ type GetOptions<T> = T extends {
153
135
  queryFnData: infer TQueryFnData;
154
136
  error?: infer TError;
155
137
  data: infer TData;
156
- } ? CreateQueryOptionsForCreateQueries<TQueryFnData, TError, TData> : T extends {
138
+ } ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData> : T extends {
157
139
  queryFnData: infer TQueryFnData;
158
140
  error?: infer TError;
159
- } ? CreateQueryOptionsForCreateQueries<TQueryFnData, TError> : T extends {
141
+ } ? UseQueryOptionsForUseQueries<TQueryFnData, TError> : T extends {
160
142
  data: infer TData;
161
143
  error?: infer TError;
162
- } ? CreateQueryOptionsForCreateQueries<unknown, TError, TData> : T extends [infer TQueryFnData, infer TError, infer TData] ? CreateQueryOptionsForCreateQueries<TQueryFnData, TError, TData> : T extends [infer TQueryFnData, infer TError] ? CreateQueryOptionsForCreateQueries<TQueryFnData, TError> : T extends [infer TQueryFnData] ? CreateQueryOptionsForCreateQueries<TQueryFnData> : T extends {
144
+ } ? 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 {
163
145
  queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey> | SkipTokenForUseQueries;
164
146
  select?: (data: any) => infer TData;
165
147
  throwOnError?: ThrowOnError<any, infer TError, any, any>;
166
- } ? CreateQueryOptionsForCreateQueries<TQueryFnData, unknown extends TError ? DefaultError : TError, unknown extends TData ? TQueryFnData : TData, TQueryKey> : CreateQueryOptionsForCreateQueries;
148
+ } ? UseQueryOptionsForUseQueries<TQueryFnData, unknown extends TError ? DefaultError : TError, unknown extends TData ? TQueryFnData : TData, TQueryKey> : UseQueryOptionsForUseQueries;
167
149
  type GetResults<T> = T extends {
168
150
  queryFnData: any;
169
151
  error?: infer TError;
170
152
  data: infer TData;
171
- } ? CreateQueryResult<TData, TError> : T extends {
153
+ } ? UseQueryResult<TData, TError> : T extends {
172
154
  queryFnData: infer TQueryFnData;
173
155
  error?: infer TError;
174
- } ? CreateQueryResult<TQueryFnData, TError> : T extends {
156
+ } ? UseQueryResult<TQueryFnData, TError> : T extends {
175
157
  data: infer TData;
176
158
  error?: infer TError;
177
- } ? CreateQueryResult<TData, TError> : T extends [any, infer TError, infer TData] ? CreateQueryResult<TData, TError> : T extends [infer TQueryFnData, infer TError] ? CreateQueryResult<TQueryFnData, TError> : T extends [infer TQueryFnData] ? CreateQueryResult<TQueryFnData> : T extends {
159
+ } ? 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 {
178
160
  queryFn?: QueryFunction<infer TQueryFnData, any> | SkipTokenForUseQueries;
179
161
  select?: (data: any) => infer TData;
180
162
  throwOnError?: ThrowOnError<any, infer TError, any, any>;
181
- } ? CreateQueryResult<unknown extends TData ? TQueryFnData : TData, unknown extends TError ? DefaultError : TError> : CreateQueryResult;
163
+ } ? UseQueryResult<unknown extends TData ? TQueryFnData : TData, unknown extends TError ? DefaultError : TError> : UseQueryResult;
182
164
  /**
183
165
  * QueriesOptions reducer recursively unwraps function arguments to infer/enforce type param
184
166
  */
185
- type QueriesOptions<T extends Array<any>, TResult extends Array<any> = [], TDepth extends ReadonlyArray<number> = []> = TDepth['length'] extends MAXIMUM_DEPTH ? Array<CreateQueryOptionsForCreateQueries> : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetOptions<Head>] : T extends [infer Head, ...infer Tail] ? QueriesOptions<[
167
+ type QueriesOptions<T extends Array<any>, TResult extends Array<any> = [], TDepth extends ReadonlyArray<number> = []> = TDepth['length'] extends MAXIMUM_DEPTH ? Array<UseQueryOptionsForUseQueries> : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetOptions<Head>] : T extends [infer Head, ...infer Tail] ? QueriesOptions<[
186
168
  ...Tail
187
169
  ], [
188
170
  ...TResult,
@@ -190,11 +172,11 @@ type QueriesOptions<T extends Array<any>, TResult extends Array<any> = [], TDept
190
172
  ], [
191
173
  ...TDepth,
192
174
  1
193
- ]> : ReadonlyArray<unknown> extends T ? T : T extends Array<CreateQueryOptionsForCreateQueries<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>> ? Array<CreateQueryOptionsForCreateQueries<TQueryFnData, TError, TData, TQueryKey>> : Array<CreateQueryOptionsForCreateQueries>;
175
+ ]> : ReadonlyArray<unknown> extends T ? T : T extends Array<UseQueryOptionsForUseQueries<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>> ? Array<UseQueryOptionsForUseQueries<TQueryFnData, TError, TData, TQueryKey>> : Array<UseQueryOptionsForUseQueries>;
194
176
  /**
195
177
  * QueriesResults reducer recursively maps type param to results
196
178
  */
197
- type QueriesResults<T extends Array<any>, TResult extends Array<any> = [], TDepth extends ReadonlyArray<number> = []> = TDepth['length'] extends MAXIMUM_DEPTH ? Array<CreateQueryResult> : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetResults<Head>] : T extends [infer Head, ...infer Tail] ? QueriesResults<[
179
+ type QueriesResults<T extends Array<any>, TResult extends Array<any> = [], TDepth extends ReadonlyArray<number> = []> = TDepth['length'] extends MAXIMUM_DEPTH ? Array<UseQueryResult> : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetResults<Head>] : T extends [infer Head, ...infer Tail] ? QueriesResults<[
198
180
  ...Tail
199
181
  ], [
200
182
  ...TResult,
@@ -205,14 +187,73 @@ type QueriesResults<T extends Array<any>, TResult extends Array<any> = [], TDept
205
187
  ]> : {
206
188
  [K in keyof T]: GetResults<T[K]>;
207
189
  };
208
- declare function createQueries<T extends Array<any>, TCombinedResult extends QueriesResults<T> = QueriesResults<T>>(queriesOptions: Accessor<{
190
+ declare function useQueries<T extends Array<any>, TCombinedResult extends QueriesResults<T> = QueriesResults<T>>(queriesOptions: Accessor<{
209
191
  queries: readonly [...QueriesOptions<T>] | readonly [...{
210
192
  [K in keyof T]: GetOptions<T[K]>;
211
193
  }];
212
194
  combine?: (result: QueriesResults<T>) => TCombinedResult;
213
195
  }>, queryClient?: Accessor<QueryClient>): TCombinedResult;
214
196
 
197
+ declare const QueryClientContext: solid_js.Context<(() => QueryClient) | undefined>;
198
+ declare const useQueryClient: (queryClient?: QueryClient) => QueryClient;
199
+ type QueryClientProviderProps = {
200
+ client: QueryClient;
201
+ children?: JSX.Element;
202
+ };
203
+ declare const QueryClientProvider: (props: QueryClientProviderProps) => JSX.Element;
204
+
205
+ declare function useIsFetching(filters?: Accessor<QueryFilters>, queryClient?: Accessor<QueryClient>): Accessor<number>;
206
+
207
+ declare function useIsMutating(filters?: Accessor<MutationFilters>, queryClient?: Accessor<QueryClient>): Accessor<number>;
208
+
209
+ type MutationStateOptions<TResult = MutationState> = {
210
+ filters?: MutationFilters;
211
+ select?: (mutation: Mutation) => TResult;
212
+ };
213
+ declare function useMutationState<TResult = MutationState>(options?: Accessor<MutationStateOptions<TResult>>, queryClient?: Accessor<QueryClient>): Accessor<Array<TResult>>;
214
+
215
215
  declare const useIsRestoring: () => Accessor<boolean>;
216
216
  declare const IsRestoringProvider: solid_js.ContextProviderComponent<Accessor<boolean>>;
217
217
 
218
- export { type CreateBaseMutationResult, type CreateBaseQueryOptions, type CreateBaseQueryResult, type CreateInfiniteQueryOptions, type CreateInfiniteQueryResult, type CreateMutateAsyncFunction, type CreateMutateFunction, type CreateMutationOptions, type CreateMutationResult, type CreateQueryOptions, type CreateQueryResult, type DefaultOptions, type DefinedCreateBaseQueryResult, type DefinedCreateInfiniteQueryResult, type DefinedCreateQueryResult, type DefinedInitialDataInfiniteOptions, type DefinedInitialDataOptions, type InfiniteQueryObserverOptions, IsRestoringProvider, QueryClient, type QueryClientConfig, QueryClientContext, QueryClientProvider, type QueryClientProviderProps, type QueryObserverOptions, type SolidInfiniteQueryOptions, type SolidMutationOptions, type SolidQueryOptions, type UndefinedInitialDataInfiniteOptions, type UndefinedInitialDataOptions, createInfiniteQuery, createMutation, createQueries, createQuery, infiniteQueryOptions, queryOptions, useIsFetching, useIsMutating, useIsRestoring, useMutationState, useQueryClient };
218
+ /** @deprecated Use UseQueryOptions instead */
219
+ type CreateQueryOptions = UseQueryOptions;
220
+ /** @deprecated Use UseBaseQueryResult instead */
221
+ type CreateBaseQueryResult = UseBaseQueryResult;
222
+ /** @deprecated Use UseQueryResult instead */
223
+ type CreateQueryResult = UseQueryResult;
224
+ /** @deprecated Use DefinedUseBaseQueryResult instead */
225
+ type DefinedCreateBaseQueryResult = DefinedUseBaseQueryResult;
226
+ /** @deprecated Use DefinedUseQueryResult instead */
227
+ type DefinedCreateQueryResult = DefinedUseQueryResult;
228
+ /** @deprecated Use UseInfiniteQueryOptions instead */
229
+ type CreateInfiniteQueryOptions = UseInfiniteQueryOptions;
230
+ /** @deprecated Use UseInfiniteQueryResult instead */
231
+ type CreateInfiniteQueryResult = UseInfiniteQueryResult;
232
+ /** @deprecated Use DefinedUseInfiniteQueryResult instead */
233
+ type DefinedCreateInfiniteQueryResult = DefinedUseInfiniteQueryResult;
234
+ /** @deprecated Use UseMutationOptions instead */
235
+ type CreateMutationOptions = UseMutationOptions;
236
+ /** @deprecated Use UseMutateFunction instead */
237
+ type CreateMutateFunction = UseMutateFunction;
238
+ /** @deprecated Use UseMutateAsyncFunction instead */
239
+ type CreateMutateAsyncFunction = UseMutateAsyncFunction;
240
+ /** @deprecated Use UseBaseMutationResult instead */
241
+ type CreateBaseMutationResult = UseBaseMutationResult;
242
+ /** @deprecated Use UseMutationResult instead */
243
+ type CreateMutationResult = UseMutationResult;
244
+ /** @deprecated Use UseBaseQueryOptions instead */
245
+ type CreateBaseQueryOptions = UseBaseQueryOptions;
246
+
247
+ /** @deprecated Use useQuery instead */
248
+ declare const createQuery: typeof useQuery;
249
+
250
+ /** @deprecated Use useInfiniteQuery instead */
251
+ declare const createInfiniteQuery: typeof useInfiniteQuery;
252
+
253
+ /** @deprecated Use useMutation instead */
254
+ declare const createMutation: typeof useMutation;
255
+
256
+ /** @deprecated Use useQueries instead */
257
+ declare const createQueries: typeof useQueries;
258
+
259
+ export { type CreateBaseMutationResult, type CreateBaseQueryOptions, type CreateBaseQueryResult, type CreateInfiniteQueryOptions, type CreateInfiniteQueryResult, type CreateMutateAsyncFunction, type CreateMutateFunction, type CreateMutationOptions, type CreateMutationResult, type CreateQueryOptions, type CreateQueryResult, type DefaultOptions, type DefinedCreateBaseQueryResult, type DefinedCreateInfiniteQueryResult, type DefinedCreateQueryResult, type DefinedInitialDataInfiniteOptions, type DefinedInitialDataOptions, type DefinedUseBaseQueryResult, type DefinedUseInfiniteQueryResult, type DefinedUseQueryResult, type InfiniteQueryObserverOptions, IsRestoringProvider, QueryClient, type QueryClientConfig, QueryClientContext, QueryClientProvider, type QueryClientProviderProps, type QueryObserverOptions, type SolidInfiniteQueryOptions, type SolidMutationOptions, type SolidQueryOptions, type UndefinedInitialDataInfiniteOptions, type UndefinedInitialDataOptions, type UseBaseMutationResult, type UseBaseQueryOptions, type UseBaseQueryResult, type UseInfiniteQueryOptions, type UseInfiniteQueryResult, type UseMutateAsyncFunction, type UseMutateFunction, type UseMutationOptions, type UseMutationResult, type UseQueryOptions, type UseQueryResult, createInfiniteQuery, createMutation, createQueries, createQuery, infiniteQueryOptions, queryOptions, useInfiniteQuery, useIsFetching, useIsMutating, useIsRestoring, useMutation, useMutationState, useQueries, useQuery, useQueryClient };