@tanstack/solid-query 5.71.7 → 5.71.8
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/dev.cjs +18 -17
- package/build/dev.js +16 -11
- package/build/index.cjs +18 -17
- package/build/index.d.cts +68 -40
- package/build/index.d.ts +68 -40
- package/build/index.js +16 -11
- package/package.json +1 -1
- package/src/QueryClient.ts +85 -0
- package/src/QueryClientProvider.tsx +1 -2
- package/src/{useBaseQuery.ts → createBaseQuery.ts} +4 -5
- package/src/{useInfiniteQuery.ts → createInfiniteQuery.ts} +14 -15
- package/src/{useMutation.ts → createMutation.ts} +10 -9
- package/src/{useQueries.ts → createQueries.ts} +26 -26
- package/src/{useQuery.ts → createQuery.ts} +13 -12
- package/src/index.ts +10 -46
- package/src/types.ts +26 -25
- package/src/useIsFetching.ts +2 -1
- package/src/useIsMutating.ts +2 -1
- package/src/useMutationState.ts +1 -1
package/build/dev.cjs
CHANGED
|
@@ -6,6 +6,11 @@ var web = require('solid-js/web');
|
|
|
6
6
|
var store = require('solid-js/store');
|
|
7
7
|
|
|
8
8
|
// src/index.ts
|
|
9
|
+
exports.QueryClient = class QueryClient extends queryCore.QueryClient {
|
|
10
|
+
constructor(config = {}) {
|
|
11
|
+
super(config);
|
|
12
|
+
}
|
|
13
|
+
};
|
|
9
14
|
exports.QueryClientContext = solidJs.createContext(void 0);
|
|
10
15
|
exports.useQueryClient = (queryClient) => {
|
|
11
16
|
if (queryClient) {
|
|
@@ -45,7 +50,7 @@ var IsRestoringContext = solidJs.createContext(() => false);
|
|
|
45
50
|
exports.useIsRestoring = () => solidJs.useContext(IsRestoringContext);
|
|
46
51
|
exports.IsRestoringProvider = IsRestoringContext.Provider;
|
|
47
52
|
|
|
48
|
-
// src/
|
|
53
|
+
// src/createBaseQuery.ts
|
|
49
54
|
function reconcileFn(store$1, result, reconcileOption, queryHash) {
|
|
50
55
|
if (reconcileOption === false) return result;
|
|
51
56
|
if (typeof reconcileOption === "function") {
|
|
@@ -91,7 +96,7 @@ var hydratableObserverResult = (query, result) => {
|
|
|
91
96
|
};
|
|
92
97
|
return obj;
|
|
93
98
|
};
|
|
94
|
-
function
|
|
99
|
+
function createBaseQuery(options, Observer, queryClient) {
|
|
95
100
|
const client = solidJs.createMemo(() => exports.useQueryClient(queryClient?.()));
|
|
96
101
|
const isRestoring = exports.useIsRestoring();
|
|
97
102
|
let unsubscribeQueued = false;
|
|
@@ -297,9 +302,9 @@ function useBaseQuery(options, Observer, queryClient) {
|
|
|
297
302
|
return new Proxy(state, handler);
|
|
298
303
|
}
|
|
299
304
|
|
|
300
|
-
// src/
|
|
301
|
-
function
|
|
302
|
-
return
|
|
305
|
+
// src/createQuery.ts
|
|
306
|
+
function createQuery(options, queryClient) {
|
|
307
|
+
return createBaseQuery(
|
|
303
308
|
solidJs.createMemo(() => options()),
|
|
304
309
|
queryCore.QueryObserver,
|
|
305
310
|
queryClient
|
|
@@ -320,8 +325,8 @@ function useIsFetching(filters, queryClient) {
|
|
|
320
325
|
solidJs.onCleanup(unsubscribe);
|
|
321
326
|
return fetches;
|
|
322
327
|
}
|
|
323
|
-
function
|
|
324
|
-
return
|
|
328
|
+
function createInfiniteQuery(options, queryClient) {
|
|
329
|
+
return createBaseQuery(
|
|
325
330
|
solidJs.createMemo(() => options()),
|
|
326
331
|
queryCore.InfiniteQueryObserver,
|
|
327
332
|
queryClient
|
|
@@ -332,7 +337,7 @@ function useInfiniteQuery(options, queryClient) {
|
|
|
332
337
|
function infiniteQueryOptions(options) {
|
|
333
338
|
return options;
|
|
334
339
|
}
|
|
335
|
-
function
|
|
340
|
+
function createMutation(options, queryClient) {
|
|
336
341
|
const client = solidJs.createMemo(() => exports.useQueryClient(queryClient?.()));
|
|
337
342
|
const observer = new queryCore.MutationObserver(
|
|
338
343
|
client(),
|
|
@@ -406,7 +411,7 @@ function useMutationState(options = () => ({}), queryClient) {
|
|
|
406
411
|
});
|
|
407
412
|
return result;
|
|
408
413
|
}
|
|
409
|
-
function
|
|
414
|
+
function createQueries(queriesOptions, queryClient) {
|
|
410
415
|
const client = solidJs.createMemo(() => exports.useQueryClient(queryClient?.()));
|
|
411
416
|
const isRestoring = exports.useIsRestoring();
|
|
412
417
|
const defaultedQueries = solidJs.createMemo(
|
|
@@ -524,19 +529,15 @@ function useQueries(queriesOptions, queryClient) {
|
|
|
524
529
|
return proxyState;
|
|
525
530
|
}
|
|
526
531
|
|
|
527
|
-
exports.createInfiniteQuery =
|
|
528
|
-
exports.createMutation =
|
|
529
|
-
exports.createQueries =
|
|
530
|
-
exports.createQuery =
|
|
532
|
+
exports.createInfiniteQuery = createInfiniteQuery;
|
|
533
|
+
exports.createMutation = createMutation;
|
|
534
|
+
exports.createQueries = createQueries;
|
|
535
|
+
exports.createQuery = createQuery;
|
|
531
536
|
exports.infiniteQueryOptions = infiniteQueryOptions;
|
|
532
537
|
exports.queryOptions = queryOptions;
|
|
533
|
-
exports.useInfiniteQuery = useInfiniteQuery;
|
|
534
538
|
exports.useIsFetching = useIsFetching;
|
|
535
539
|
exports.useIsMutating = useIsMutating;
|
|
536
|
-
exports.useMutation = useMutation;
|
|
537
540
|
exports.useMutationState = useMutationState;
|
|
538
|
-
exports.useQueries = useQueries;
|
|
539
|
-
exports.useQuery = useQuery;
|
|
540
541
|
Object.keys(queryCore).forEach(function (k) {
|
|
541
542
|
if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
|
|
542
543
|
enumerable: true,
|
package/build/dev.js
CHANGED
|
@@ -1,10 +1,15 @@
|
|
|
1
|
-
import { MutationObserver, replaceEqualDeep, QueriesObserver, hydrate, notifyManager, QueryObserver, InfiniteQueryObserver } from '@tanstack/query-core';
|
|
1
|
+
import { QueryClient as QueryClient$1, MutationObserver, replaceEqualDeep, QueriesObserver, hydrate, notifyManager, QueryObserver, InfiniteQueryObserver } from '@tanstack/query-core';
|
|
2
2
|
export * from '@tanstack/query-core';
|
|
3
3
|
import { createContext, useContext, createRenderEffect, onCleanup, createMemo, createSignal, createComputed, on, createEffect, mergeProps, createResource, batch, onMount } from 'solid-js';
|
|
4
4
|
import { createComponent, isServer } from 'solid-js/web';
|
|
5
5
|
import { createStore, unwrap, reconcile } from 'solid-js/store';
|
|
6
6
|
|
|
7
7
|
// src/index.ts
|
|
8
|
+
var QueryClient = class extends QueryClient$1 {
|
|
9
|
+
constructor(config = {}) {
|
|
10
|
+
super(config);
|
|
11
|
+
}
|
|
12
|
+
};
|
|
8
13
|
var QueryClientContext = createContext(void 0);
|
|
9
14
|
var useQueryClient = (queryClient) => {
|
|
10
15
|
if (queryClient) {
|
|
@@ -44,7 +49,7 @@ var IsRestoringContext = createContext(() => false);
|
|
|
44
49
|
var useIsRestoring = () => useContext(IsRestoringContext);
|
|
45
50
|
var IsRestoringProvider = IsRestoringContext.Provider;
|
|
46
51
|
|
|
47
|
-
// src/
|
|
52
|
+
// src/createBaseQuery.ts
|
|
48
53
|
function reconcileFn(store, result, reconcileOption, queryHash) {
|
|
49
54
|
if (reconcileOption === false) return result;
|
|
50
55
|
if (typeof reconcileOption === "function") {
|
|
@@ -90,7 +95,7 @@ var hydratableObserverResult = (query, result) => {
|
|
|
90
95
|
};
|
|
91
96
|
return obj;
|
|
92
97
|
};
|
|
93
|
-
function
|
|
98
|
+
function createBaseQuery(options, Observer, queryClient) {
|
|
94
99
|
const client = createMemo(() => useQueryClient(queryClient?.()));
|
|
95
100
|
const isRestoring = useIsRestoring();
|
|
96
101
|
let unsubscribeQueued = false;
|
|
@@ -296,9 +301,9 @@ function useBaseQuery(options, Observer, queryClient) {
|
|
|
296
301
|
return new Proxy(state, handler);
|
|
297
302
|
}
|
|
298
303
|
|
|
299
|
-
// src/
|
|
300
|
-
function
|
|
301
|
-
return
|
|
304
|
+
// src/createQuery.ts
|
|
305
|
+
function createQuery(options, queryClient) {
|
|
306
|
+
return createBaseQuery(
|
|
302
307
|
createMemo(() => options()),
|
|
303
308
|
QueryObserver,
|
|
304
309
|
queryClient
|
|
@@ -319,8 +324,8 @@ function useIsFetching(filters, queryClient) {
|
|
|
319
324
|
onCleanup(unsubscribe);
|
|
320
325
|
return fetches;
|
|
321
326
|
}
|
|
322
|
-
function
|
|
323
|
-
return
|
|
327
|
+
function createInfiniteQuery(options, queryClient) {
|
|
328
|
+
return createBaseQuery(
|
|
324
329
|
createMemo(() => options()),
|
|
325
330
|
InfiniteQueryObserver,
|
|
326
331
|
queryClient
|
|
@@ -331,7 +336,7 @@ function useInfiniteQuery(options, queryClient) {
|
|
|
331
336
|
function infiniteQueryOptions(options) {
|
|
332
337
|
return options;
|
|
333
338
|
}
|
|
334
|
-
function
|
|
339
|
+
function createMutation(options, queryClient) {
|
|
335
340
|
const client = createMemo(() => useQueryClient(queryClient?.()));
|
|
336
341
|
const observer = new MutationObserver(
|
|
337
342
|
client(),
|
|
@@ -405,7 +410,7 @@ function useMutationState(options = () => ({}), queryClient) {
|
|
|
405
410
|
});
|
|
406
411
|
return result;
|
|
407
412
|
}
|
|
408
|
-
function
|
|
413
|
+
function createQueries(queriesOptions, queryClient) {
|
|
409
414
|
const client = createMemo(() => useQueryClient(queryClient?.()));
|
|
410
415
|
const isRestoring = useIsRestoring();
|
|
411
416
|
const defaultedQueries = createMemo(
|
|
@@ -523,4 +528,4 @@ function useQueries(queriesOptions, queryClient) {
|
|
|
523
528
|
return proxyState;
|
|
524
529
|
}
|
|
525
530
|
|
|
526
|
-
export { IsRestoringProvider, QueryClientContext, QueryClientProvider,
|
|
531
|
+
export { IsRestoringProvider, QueryClient, QueryClientContext, QueryClientProvider, createInfiniteQuery, createMutation, createQueries, createQuery, infiniteQueryOptions, queryOptions, useIsFetching, useIsMutating, useIsRestoring, useMutationState, useQueryClient };
|
package/build/index.cjs
CHANGED
|
@@ -6,6 +6,11 @@ var web = require('solid-js/web');
|
|
|
6
6
|
var store = require('solid-js/store');
|
|
7
7
|
|
|
8
8
|
// src/index.ts
|
|
9
|
+
exports.QueryClient = class QueryClient extends queryCore.QueryClient {
|
|
10
|
+
constructor(config = {}) {
|
|
11
|
+
super(config);
|
|
12
|
+
}
|
|
13
|
+
};
|
|
9
14
|
exports.QueryClientContext = solidJs.createContext(void 0);
|
|
10
15
|
exports.useQueryClient = (queryClient) => {
|
|
11
16
|
if (queryClient) {
|
|
@@ -45,7 +50,7 @@ var IsRestoringContext = solidJs.createContext(() => false);
|
|
|
45
50
|
exports.useIsRestoring = () => solidJs.useContext(IsRestoringContext);
|
|
46
51
|
exports.IsRestoringProvider = IsRestoringContext.Provider;
|
|
47
52
|
|
|
48
|
-
// src/
|
|
53
|
+
// src/createBaseQuery.ts
|
|
49
54
|
function reconcileFn(store$1, result, reconcileOption, queryHash) {
|
|
50
55
|
if (reconcileOption === false) return result;
|
|
51
56
|
if (typeof reconcileOption === "function") {
|
|
@@ -82,7 +87,7 @@ var hydratableObserverResult = (query, result) => {
|
|
|
82
87
|
};
|
|
83
88
|
return obj;
|
|
84
89
|
};
|
|
85
|
-
function
|
|
90
|
+
function createBaseQuery(options, Observer, queryClient) {
|
|
86
91
|
const client = solidJs.createMemo(() => exports.useQueryClient(queryClient?.()));
|
|
87
92
|
const isRestoring = exports.useIsRestoring();
|
|
88
93
|
let unsubscribeQueued = false;
|
|
@@ -288,9 +293,9 @@ function useBaseQuery(options, Observer, queryClient) {
|
|
|
288
293
|
return new Proxy(state, handler);
|
|
289
294
|
}
|
|
290
295
|
|
|
291
|
-
// src/
|
|
292
|
-
function
|
|
293
|
-
return
|
|
296
|
+
// src/createQuery.ts
|
|
297
|
+
function createQuery(options, queryClient) {
|
|
298
|
+
return createBaseQuery(
|
|
294
299
|
solidJs.createMemo(() => options()),
|
|
295
300
|
queryCore.QueryObserver,
|
|
296
301
|
queryClient
|
|
@@ -311,8 +316,8 @@ function useIsFetching(filters, queryClient) {
|
|
|
311
316
|
solidJs.onCleanup(unsubscribe);
|
|
312
317
|
return fetches;
|
|
313
318
|
}
|
|
314
|
-
function
|
|
315
|
-
return
|
|
319
|
+
function createInfiniteQuery(options, queryClient) {
|
|
320
|
+
return createBaseQuery(
|
|
316
321
|
solidJs.createMemo(() => options()),
|
|
317
322
|
queryCore.InfiniteQueryObserver,
|
|
318
323
|
queryClient
|
|
@@ -323,7 +328,7 @@ function useInfiniteQuery(options, queryClient) {
|
|
|
323
328
|
function infiniteQueryOptions(options) {
|
|
324
329
|
return options;
|
|
325
330
|
}
|
|
326
|
-
function
|
|
331
|
+
function createMutation(options, queryClient) {
|
|
327
332
|
const client = solidJs.createMemo(() => exports.useQueryClient(queryClient?.()));
|
|
328
333
|
const observer = new queryCore.MutationObserver(
|
|
329
334
|
client(),
|
|
@@ -397,7 +402,7 @@ function useMutationState(options = () => ({}), queryClient) {
|
|
|
397
402
|
});
|
|
398
403
|
return result;
|
|
399
404
|
}
|
|
400
|
-
function
|
|
405
|
+
function createQueries(queriesOptions, queryClient) {
|
|
401
406
|
const client = solidJs.createMemo(() => exports.useQueryClient(queryClient?.()));
|
|
402
407
|
const isRestoring = exports.useIsRestoring();
|
|
403
408
|
const defaultedQueries = solidJs.createMemo(
|
|
@@ -515,19 +520,15 @@ function useQueries(queriesOptions, queryClient) {
|
|
|
515
520
|
return proxyState;
|
|
516
521
|
}
|
|
517
522
|
|
|
518
|
-
exports.createInfiniteQuery =
|
|
519
|
-
exports.createMutation =
|
|
520
|
-
exports.createQueries =
|
|
521
|
-
exports.createQuery =
|
|
523
|
+
exports.createInfiniteQuery = createInfiniteQuery;
|
|
524
|
+
exports.createMutation = createMutation;
|
|
525
|
+
exports.createQueries = createQueries;
|
|
526
|
+
exports.createQuery = createQuery;
|
|
522
527
|
exports.infiniteQueryOptions = infiniteQueryOptions;
|
|
523
528
|
exports.queryOptions = queryOptions;
|
|
524
|
-
exports.useInfiniteQuery = useInfiniteQuery;
|
|
525
529
|
exports.useIsFetching = useIsFetching;
|
|
526
530
|
exports.useIsMutating = useIsMutating;
|
|
527
|
-
exports.useMutation = useMutation;
|
|
528
531
|
exports.useMutationState = useMutationState;
|
|
529
|
-
exports.useQueries = useQueries;
|
|
530
|
-
exports.useQuery = useQuery;
|
|
531
532
|
Object.keys(queryCore).forEach(function (k) {
|
|
532
533
|
if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
|
|
533
534
|
enumerable: true,
|
package/build/index.d.cts
CHANGED
|
@@ -1,9 +1,37 @@
|
|
|
1
|
-
import { DefaultError,
|
|
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';
|
|
2
2
|
export * from '@tanstack/query-core';
|
|
3
3
|
import * as solid_js from 'solid-js';
|
|
4
4
|
import { Accessor, JSX } from 'solid-js';
|
|
5
5
|
|
|
6
|
-
interface
|
|
6
|
+
interface QueryObserverOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = never> extends OmitKeyof<QueryObserverOptions$1<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>, 'structuralSharing'> {
|
|
7
|
+
/**
|
|
8
|
+
* Set this to a reconciliation key to enable reconciliation between query results.
|
|
9
|
+
* Set this to `false` to disable reconciliation between query results.
|
|
10
|
+
* Set this to a function which accepts the old and new data and returns resolved data of the same type to implement custom reconciliation logic.
|
|
11
|
+
* Defaults reconciliation to false.
|
|
12
|
+
*/
|
|
13
|
+
reconcile?: string | false | ((oldData: TData | undefined, newData: TData) => TData);
|
|
14
|
+
}
|
|
15
|
+
interface InfiniteQueryObserverOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryData = TQueryFnData, TQueryKey extends QueryKey = QueryKey, TPageParam = unknown> extends OmitKeyof<InfiniteQueryObserverOptions$1<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>, 'structuralSharing'> {
|
|
16
|
+
/**
|
|
17
|
+
* Set this to a reconciliation key to enable reconciliation between query results.
|
|
18
|
+
* Set this to `false` to disable reconciliation between query results.
|
|
19
|
+
* Set this to a function which accepts the old and new data and returns resolved data of the same type to implement custom reconciliation logic.
|
|
20
|
+
* Defaults reconciliation to false.
|
|
21
|
+
*/
|
|
22
|
+
reconcile?: string | false | ((oldData: TData | undefined, newData: TData) => TData);
|
|
23
|
+
}
|
|
24
|
+
interface DefaultOptions<TError = DefaultError> extends DefaultOptions$1<TError> {
|
|
25
|
+
queries?: OmitKeyof<QueryObserverOptions<unknown, TError>, 'queryKey'>;
|
|
26
|
+
}
|
|
27
|
+
interface QueryClientConfig extends QueryClientConfig$1 {
|
|
28
|
+
defaultOptions?: DefaultOptions;
|
|
29
|
+
}
|
|
30
|
+
declare class QueryClient extends QueryClient$1 {
|
|
31
|
+
constructor(config?: QueryClientConfig);
|
|
32
|
+
}
|
|
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'> {
|
|
7
35
|
/**
|
|
8
36
|
* Only applicable while rendering queries on the server with streaming.
|
|
9
37
|
* Set `deferStream` to `true` to wait for the query to resolve on the server before flushing the stream.
|
|
@@ -13,18 +41,18 @@ interface UseBaseQueryOptions<TQueryFnData = unknown, TError = DefaultError, TDa
|
|
|
13
41
|
deferStream?: boolean;
|
|
14
42
|
/**
|
|
15
43
|
* @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
|
|
16
|
-
* The `data` property on
|
|
44
|
+
* The `data` property on createQuery is a SolidJS resource and will automatically suspend when the data is loading.
|
|
17
45
|
* Setting `suspense` to `false` will be a no-op.
|
|
18
46
|
*/
|
|
19
47
|
suspense?: boolean;
|
|
20
48
|
}
|
|
21
|
-
interface SolidQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends
|
|
49
|
+
interface SolidQueryOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> extends CreateBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey> {
|
|
22
50
|
}
|
|
23
|
-
type
|
|
24
|
-
type
|
|
25
|
-
type
|
|
26
|
-
type
|
|
27
|
-
type
|
|
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>;
|
|
28
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'> {
|
|
29
57
|
queryKey: TQueryKey;
|
|
30
58
|
/**
|
|
@@ -36,25 +64,25 @@ interface SolidInfiniteQueryOptions<TQueryFnData = unknown, TError = DefaultErro
|
|
|
36
64
|
deferStream?: boolean;
|
|
37
65
|
/**
|
|
38
66
|
* @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
|
|
39
|
-
* The `data` property on
|
|
67
|
+
* The `data` property on createInfiniteQuery is a SolidJS resource and will automatically suspend when the data is loading.
|
|
40
68
|
* Setting `suspense` to `false` will be a no-op.
|
|
41
69
|
*/
|
|
42
70
|
suspense?: boolean;
|
|
43
71
|
}
|
|
44
|
-
type
|
|
45
|
-
type
|
|
46
|
-
type
|
|
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>;
|
|
47
75
|
interface SolidMutationOptions<TData = unknown, TError = DefaultError, TVariables = void, TContext = unknown> extends OmitKeyof<MutationObserverOptions<TData, TError, TVariables, TContext>, '_defaulted'> {
|
|
48
76
|
}
|
|
49
|
-
type
|
|
50
|
-
type
|
|
51
|
-
type
|
|
52
|
-
type
|
|
53
|
-
mutate:
|
|
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>;
|
|
54
82
|
}> & {
|
|
55
|
-
mutateAsync:
|
|
83
|
+
mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TContext>;
|
|
56
84
|
};
|
|
57
|
-
type
|
|
85
|
+
type CreateMutationResult<TData = unknown, TError = DefaultError, TVariables = unknown, TContext = unknown> = CreateBaseMutationResult<TData, TError, TVariables, TContext>;
|
|
58
86
|
|
|
59
87
|
type UndefinedInitialDataOptions<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = Accessor<SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
|
|
60
88
|
initialData?: undefined;
|
|
@@ -69,8 +97,8 @@ declare function queryOptions<TQueryFnData = unknown, TError = DefaultError, TDa
|
|
|
69
97
|
queryKey: DataTag<TQueryKey, TQueryFnData>;
|
|
70
98
|
};
|
|
71
99
|
|
|
72
|
-
declare function
|
|
73
|
-
declare function
|
|
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>;
|
|
74
102
|
|
|
75
103
|
declare const QueryClientContext: solid_js.Context<(() => QueryClient) | undefined>;
|
|
76
104
|
declare const useQueryClient: (queryClient?: QueryClient) => QueryClient;
|
|
@@ -96,10 +124,10 @@ declare function infiniteQueryOptions<TQueryFnData, TError = DefaultError, TData
|
|
|
96
124
|
queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>>;
|
|
97
125
|
};
|
|
98
126
|
|
|
99
|
-
declare function
|
|
100
|
-
declare function
|
|
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>;
|
|
101
129
|
|
|
102
|
-
declare function
|
|
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>;
|
|
103
131
|
|
|
104
132
|
declare function useIsMutating(filters?: Accessor<MutationFilters>, queryClient?: Accessor<QueryClient>): Accessor<number>;
|
|
105
133
|
|
|
@@ -109,11 +137,11 @@ type MutationStateOptions<TResult = MutationState> = {
|
|
|
109
137
|
};
|
|
110
138
|
declare function useMutationState<TResult = MutationState>(options?: Accessor<MutationStateOptions<TResult>>, queryClient?: Accessor<QueryClient>): Accessor<Array<TResult>>;
|
|
111
139
|
|
|
112
|
-
type
|
|
140
|
+
type CreateQueryOptionsForCreateQueries<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData, TQueryKey extends QueryKey = QueryKey> = OmitKeyof<SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey>, 'placeholderData' | 'suspense'> & {
|
|
113
141
|
placeholderData?: TQueryFnData | QueriesPlaceholderDataFunction<TQueryFnData>;
|
|
114
142
|
/**
|
|
115
143
|
* @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
|
|
116
|
-
* The `data` property on
|
|
144
|
+
* The `data` property on createQueries is a plain object and not a SolidJS Resource.
|
|
117
145
|
* It will not suspend when the data is loading.
|
|
118
146
|
* Setting `suspense` to `true` will be a no-op.
|
|
119
147
|
*/
|
|
@@ -125,36 +153,36 @@ type GetOptions<T> = T extends {
|
|
|
125
153
|
queryFnData: infer TQueryFnData;
|
|
126
154
|
error?: infer TError;
|
|
127
155
|
data: infer TData;
|
|
128
|
-
} ?
|
|
156
|
+
} ? CreateQueryOptionsForCreateQueries<TQueryFnData, TError, TData> : T extends {
|
|
129
157
|
queryFnData: infer TQueryFnData;
|
|
130
158
|
error?: infer TError;
|
|
131
|
-
} ?
|
|
159
|
+
} ? CreateQueryOptionsForCreateQueries<TQueryFnData, TError> : T extends {
|
|
132
160
|
data: infer TData;
|
|
133
161
|
error?: infer TError;
|
|
134
|
-
} ?
|
|
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 {
|
|
135
163
|
queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey> | SkipTokenForUseQueries;
|
|
136
164
|
select?: (data: any) => infer TData;
|
|
137
165
|
throwOnError?: ThrowOnError<any, infer TError, any, any>;
|
|
138
|
-
} ?
|
|
166
|
+
} ? CreateQueryOptionsForCreateQueries<TQueryFnData, unknown extends TError ? DefaultError : TError, unknown extends TData ? TQueryFnData : TData, TQueryKey> : CreateQueryOptionsForCreateQueries;
|
|
139
167
|
type GetResults<T> = T extends {
|
|
140
168
|
queryFnData: any;
|
|
141
169
|
error?: infer TError;
|
|
142
170
|
data: infer TData;
|
|
143
|
-
} ?
|
|
171
|
+
} ? CreateQueryResult<TData, TError> : T extends {
|
|
144
172
|
queryFnData: infer TQueryFnData;
|
|
145
173
|
error?: infer TError;
|
|
146
|
-
} ?
|
|
174
|
+
} ? CreateQueryResult<TQueryFnData, TError> : T extends {
|
|
147
175
|
data: infer TData;
|
|
148
176
|
error?: infer TError;
|
|
149
|
-
} ?
|
|
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 {
|
|
150
178
|
queryFn?: QueryFunction<infer TQueryFnData, any> | SkipTokenForUseQueries;
|
|
151
179
|
select?: (data: any) => infer TData;
|
|
152
180
|
throwOnError?: ThrowOnError<any, infer TError, any, any>;
|
|
153
|
-
} ?
|
|
181
|
+
} ? CreateQueryResult<unknown extends TData ? TQueryFnData : TData, unknown extends TError ? DefaultError : TError> : CreateQueryResult;
|
|
154
182
|
/**
|
|
155
183
|
* QueriesOptions reducer recursively unwraps function arguments to infer/enforce type param
|
|
156
184
|
*/
|
|
157
|
-
type QueriesOptions<T extends Array<any>, TResult extends Array<any> = [], TDepth extends ReadonlyArray<number> = []> = TDepth['length'] extends MAXIMUM_DEPTH ? Array<
|
|
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<[
|
|
158
186
|
...Tail
|
|
159
187
|
], [
|
|
160
188
|
...TResult,
|
|
@@ -162,11 +190,11 @@ type QueriesOptions<T extends Array<any>, TResult extends Array<any> = [], TDept
|
|
|
162
190
|
], [
|
|
163
191
|
...TDepth,
|
|
164
192
|
1
|
|
165
|
-
]> : ReadonlyArray<unknown> extends T ? T : T extends Array<
|
|
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>;
|
|
166
194
|
/**
|
|
167
195
|
* QueriesResults reducer recursively maps type param to results
|
|
168
196
|
*/
|
|
169
|
-
type QueriesResults<T extends Array<any>, TResult extends Array<any> = [], TDepth extends ReadonlyArray<number> = []> = TDepth['length'] extends MAXIMUM_DEPTH ? Array<
|
|
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<[
|
|
170
198
|
...Tail
|
|
171
199
|
], [
|
|
172
200
|
...TResult,
|
|
@@ -177,7 +205,7 @@ type QueriesResults<T extends Array<any>, TResult extends Array<any> = [], TDept
|
|
|
177
205
|
]> : {
|
|
178
206
|
[K in keyof T]: GetResults<T[K]>;
|
|
179
207
|
};
|
|
180
|
-
declare function
|
|
208
|
+
declare function createQueries<T extends Array<any>, TCombinedResult extends QueriesResults<T> = QueriesResults<T>>(queriesOptions: Accessor<{
|
|
181
209
|
queries: readonly [...QueriesOptions<T>] | readonly [...{
|
|
182
210
|
[K in keyof T]: GetOptions<T[K]>;
|
|
183
211
|
}];
|
|
@@ -187,4 +215,4 @@ declare function useQueries<T extends Array<any>, TCombinedResult extends Querie
|
|
|
187
215
|
declare const useIsRestoring: () => Accessor<boolean>;
|
|
188
216
|
declare const IsRestoringProvider: solid_js.ContextProviderComponent<Accessor<boolean>>;
|
|
189
217
|
|
|
190
|
-
export { type
|
|
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 };
|