@tanstack/solid-query 5.71.8 → 5.71.10
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 +82 -76
- package/build/dev.js +81 -75
- package/build/index.cjs +82 -76
- package/build/index.d.cts +99 -58
- package/build/index.d.ts +99 -58
- package/build/index.js +81 -75
- package/package.json +2 -2
- package/src/index.ts +85 -4
- package/src/types.ts +22 -22
- package/src/{createBaseQuery.ts → useBaseQuery.ts} +3 -3
- package/src/{createInfiniteQuery.ts → useInfiniteQuery.ts} +13 -13
- package/src/{createMutation.ts → useMutation.ts} +8 -8
- package/src/{createQueries.ts → useQueries.ts} +25 -25
- package/src/{createQuery.ts → useQuery.ts} +11 -11
package/build/index.js
CHANGED
|
@@ -1,15 +1,10 @@
|
|
|
1
|
-
import { QueryClient as QueryClient$1,
|
|
1
|
+
import { MutationObserver, QueriesObserver, QueryClient as QueryClient$1, replaceEqualDeep, hydrate, notifyManager, QueryObserver, InfiniteQueryObserver } from '@tanstack/query-core';
|
|
2
2
|
export * from '@tanstack/query-core';
|
|
3
|
-
import { createContext, useContext, createRenderEffect, onCleanup, createMemo,
|
|
3
|
+
import { createContext, useContext, createRenderEffect, onCleanup, createMemo, createComputed, on, mergeProps, createResource, batch, onMount, createSignal, createEffect } 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
|
-
// src/
|
|
8
|
-
var QueryClient = class extends QueryClient$1 {
|
|
9
|
-
constructor(config = {}) {
|
|
10
|
-
super(config);
|
|
11
|
-
}
|
|
12
|
-
};
|
|
7
|
+
// src/useQuery.ts
|
|
13
8
|
var QueryClientContext = createContext(void 0);
|
|
14
9
|
var useQueryClient = (queryClient) => {
|
|
15
10
|
if (queryClient) {
|
|
@@ -49,7 +44,7 @@ var IsRestoringContext = createContext(() => false);
|
|
|
49
44
|
var useIsRestoring = () => useContext(IsRestoringContext);
|
|
50
45
|
var IsRestoringProvider = IsRestoringContext.Provider;
|
|
51
46
|
|
|
52
|
-
// src/
|
|
47
|
+
// src/useBaseQuery.ts
|
|
53
48
|
function reconcileFn(store, result, reconcileOption, queryHash) {
|
|
54
49
|
if (reconcileOption === false) return result;
|
|
55
50
|
if (typeof reconcileOption === "function") {
|
|
@@ -86,7 +81,7 @@ var hydratableObserverResult = (query, result) => {
|
|
|
86
81
|
};
|
|
87
82
|
return obj;
|
|
88
83
|
};
|
|
89
|
-
function
|
|
84
|
+
function useBaseQuery(options, Observer, queryClient) {
|
|
90
85
|
const client = createMemo(() => useQueryClient(queryClient?.()));
|
|
91
86
|
const isRestoring = useIsRestoring();
|
|
92
87
|
let unsubscribeQueued = false;
|
|
@@ -292,42 +287,22 @@ function createBaseQuery(options, Observer, queryClient) {
|
|
|
292
287
|
return new Proxy(state, handler);
|
|
293
288
|
}
|
|
294
289
|
|
|
295
|
-
// src/
|
|
296
|
-
function
|
|
297
|
-
return
|
|
290
|
+
// src/useQuery.ts
|
|
291
|
+
function useQuery(options, queryClient) {
|
|
292
|
+
return useBaseQuery(
|
|
298
293
|
createMemo(() => options()),
|
|
299
294
|
QueryObserver,
|
|
300
295
|
queryClient
|
|
301
296
|
);
|
|
302
297
|
}
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
function queryOptions(options) {
|
|
306
|
-
return options;
|
|
307
|
-
}
|
|
308
|
-
function useIsFetching(filters, queryClient) {
|
|
309
|
-
const client = createMemo(() => useQueryClient(queryClient?.()));
|
|
310
|
-
const queryCache = createMemo(() => client().getQueryCache());
|
|
311
|
-
const [fetches, setFetches] = createSignal(client().isFetching(filters?.()));
|
|
312
|
-
const unsubscribe = queryCache().subscribe(() => {
|
|
313
|
-
setFetches(client().isFetching(filters?.()));
|
|
314
|
-
});
|
|
315
|
-
onCleanup(unsubscribe);
|
|
316
|
-
return fetches;
|
|
317
|
-
}
|
|
318
|
-
function createInfiniteQuery(options, queryClient) {
|
|
319
|
-
return createBaseQuery(
|
|
298
|
+
function useInfiniteQuery(options, queryClient) {
|
|
299
|
+
return useBaseQuery(
|
|
320
300
|
createMemo(() => options()),
|
|
321
301
|
InfiniteQueryObserver,
|
|
322
302
|
queryClient
|
|
323
303
|
);
|
|
324
304
|
}
|
|
325
|
-
|
|
326
|
-
// src/infiniteQueryOptions.ts
|
|
327
|
-
function infiniteQueryOptions(options) {
|
|
328
|
-
return options;
|
|
329
|
-
}
|
|
330
|
-
function createMutation(options, queryClient) {
|
|
305
|
+
function useMutation(options, queryClient) {
|
|
331
306
|
const client = createMemo(() => useQueryClient(queryClient?.()));
|
|
332
307
|
const observer = new MutationObserver(
|
|
333
308
|
client(),
|
|
@@ -364,44 +339,7 @@ function createMutation(options, queryClient) {
|
|
|
364
339
|
onCleanup(unsubscribe);
|
|
365
340
|
return state;
|
|
366
341
|
}
|
|
367
|
-
function
|
|
368
|
-
const client = createMemo(() => useQueryClient(queryClient?.()));
|
|
369
|
-
const mutationCache = createMemo(() => client().getMutationCache());
|
|
370
|
-
const [mutations, setMutations] = createSignal(
|
|
371
|
-
client().isMutating(filters?.())
|
|
372
|
-
);
|
|
373
|
-
const unsubscribe = mutationCache().subscribe((_result) => {
|
|
374
|
-
setMutations(client().isMutating(filters?.()));
|
|
375
|
-
});
|
|
376
|
-
onCleanup(unsubscribe);
|
|
377
|
-
return mutations;
|
|
378
|
-
}
|
|
379
|
-
function getResult(mutationCache, options) {
|
|
380
|
-
return mutationCache.findAll(options.filters).map(
|
|
381
|
-
(mutation) => options.select ? options.select(mutation) : mutation.state
|
|
382
|
-
);
|
|
383
|
-
}
|
|
384
|
-
function useMutationState(options = () => ({}), queryClient) {
|
|
385
|
-
const client = createMemo(() => useQueryClient(queryClient?.()));
|
|
386
|
-
const mutationCache = createMemo(() => client().getMutationCache());
|
|
387
|
-
const [result, setResult] = createSignal(
|
|
388
|
-
getResult(mutationCache(), options())
|
|
389
|
-
);
|
|
390
|
-
createEffect(() => {
|
|
391
|
-
const unsubscribe = mutationCache().subscribe(() => {
|
|
392
|
-
const nextResult = replaceEqualDeep(
|
|
393
|
-
result(),
|
|
394
|
-
getResult(mutationCache(), options())
|
|
395
|
-
);
|
|
396
|
-
if (result() !== nextResult) {
|
|
397
|
-
setResult(nextResult);
|
|
398
|
-
}
|
|
399
|
-
});
|
|
400
|
-
onCleanup(unsubscribe);
|
|
401
|
-
});
|
|
402
|
-
return result;
|
|
403
|
-
}
|
|
404
|
-
function createQueries(queriesOptions, queryClient) {
|
|
342
|
+
function useQueries(queriesOptions, queryClient) {
|
|
405
343
|
const client = createMemo(() => useQueryClient(queryClient?.()));
|
|
406
344
|
const isRestoring = useIsRestoring();
|
|
407
345
|
const defaultedQueries = createMemo(
|
|
@@ -518,5 +456,73 @@ function createQueries(queriesOptions, queryClient) {
|
|
|
518
456
|
createRenderEffect(() => setProxyState(getProxies()));
|
|
519
457
|
return proxyState;
|
|
520
458
|
}
|
|
459
|
+
var QueryClient = class extends QueryClient$1 {
|
|
460
|
+
constructor(config = {}) {
|
|
461
|
+
super(config);
|
|
462
|
+
}
|
|
463
|
+
};
|
|
464
|
+
|
|
465
|
+
// src/queryOptions.ts
|
|
466
|
+
function queryOptions(options) {
|
|
467
|
+
return options;
|
|
468
|
+
}
|
|
469
|
+
function useIsFetching(filters, queryClient) {
|
|
470
|
+
const client = createMemo(() => useQueryClient(queryClient?.()));
|
|
471
|
+
const queryCache = createMemo(() => client().getQueryCache());
|
|
472
|
+
const [fetches, setFetches] = createSignal(client().isFetching(filters?.()));
|
|
473
|
+
const unsubscribe = queryCache().subscribe(() => {
|
|
474
|
+
setFetches(client().isFetching(filters?.()));
|
|
475
|
+
});
|
|
476
|
+
onCleanup(unsubscribe);
|
|
477
|
+
return fetches;
|
|
478
|
+
}
|
|
479
|
+
|
|
480
|
+
// src/infiniteQueryOptions.ts
|
|
481
|
+
function infiniteQueryOptions(options) {
|
|
482
|
+
return options;
|
|
483
|
+
}
|
|
484
|
+
function useIsMutating(filters, queryClient) {
|
|
485
|
+
const client = createMemo(() => useQueryClient(queryClient?.()));
|
|
486
|
+
const mutationCache = createMemo(() => client().getMutationCache());
|
|
487
|
+
const [mutations, setMutations] = createSignal(
|
|
488
|
+
client().isMutating(filters?.())
|
|
489
|
+
);
|
|
490
|
+
const unsubscribe = mutationCache().subscribe((_result) => {
|
|
491
|
+
setMutations(client().isMutating(filters?.()));
|
|
492
|
+
});
|
|
493
|
+
onCleanup(unsubscribe);
|
|
494
|
+
return mutations;
|
|
495
|
+
}
|
|
496
|
+
function getResult(mutationCache, options) {
|
|
497
|
+
return mutationCache.findAll(options.filters).map(
|
|
498
|
+
(mutation) => options.select ? options.select(mutation) : mutation.state
|
|
499
|
+
);
|
|
500
|
+
}
|
|
501
|
+
function useMutationState(options = () => ({}), queryClient) {
|
|
502
|
+
const client = createMemo(() => useQueryClient(queryClient?.()));
|
|
503
|
+
const mutationCache = createMemo(() => client().getMutationCache());
|
|
504
|
+
const [result, setResult] = createSignal(
|
|
505
|
+
getResult(mutationCache(), options())
|
|
506
|
+
);
|
|
507
|
+
createEffect(() => {
|
|
508
|
+
const unsubscribe = mutationCache().subscribe(() => {
|
|
509
|
+
const nextResult = replaceEqualDeep(
|
|
510
|
+
result(),
|
|
511
|
+
getResult(mutationCache(), options())
|
|
512
|
+
);
|
|
513
|
+
if (result() !== nextResult) {
|
|
514
|
+
setResult(nextResult);
|
|
515
|
+
}
|
|
516
|
+
});
|
|
517
|
+
onCleanup(unsubscribe);
|
|
518
|
+
});
|
|
519
|
+
return result;
|
|
520
|
+
}
|
|
521
|
+
|
|
522
|
+
// src/index.ts
|
|
523
|
+
var createQuery = useQuery;
|
|
524
|
+
var createInfiniteQuery = useInfiniteQuery;
|
|
525
|
+
var createMutation = useMutation;
|
|
526
|
+
var createQueries = useQueries;
|
|
521
527
|
|
|
522
|
-
export { IsRestoringProvider, QueryClient, QueryClientContext, QueryClientProvider, createInfiniteQuery, createMutation, createQueries, createQuery, infiniteQueryOptions, queryOptions, useIsFetching, useIsMutating, useIsRestoring, useMutationState, useQueryClient };
|
|
528
|
+
export { IsRestoringProvider, QueryClient, QueryClientContext, QueryClientProvider, createInfiniteQuery, createMutation, createQueries, createQuery, infiniteQueryOptions, queryOptions, useInfiniteQuery, useIsFetching, useIsMutating, useIsRestoring, useMutation, useMutationState, useQueries, useQuery, useQueryClient };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tanstack/solid-query",
|
|
3
|
-
"version": "5.71.
|
|
3
|
+
"version": "5.71.10",
|
|
4
4
|
"description": "Primitives for managing, caching and syncing asynchronous and remote data in Solid",
|
|
5
5
|
"author": "tannerlinsley",
|
|
6
6
|
"license": "MIT",
|
|
@@ -45,7 +45,7 @@
|
|
|
45
45
|
"!src/__tests__"
|
|
46
46
|
],
|
|
47
47
|
"dependencies": {
|
|
48
|
-
"@tanstack/query-core": "5.71.
|
|
48
|
+
"@tanstack/query-core": "5.71.10"
|
|
49
49
|
},
|
|
50
50
|
"devDependencies": {
|
|
51
51
|
"@solidjs/testing-library": "^0.8.10",
|
package/src/index.ts
CHANGED
|
@@ -1,10 +1,83 @@
|
|
|
1
1
|
/* istanbul ignore file */
|
|
2
2
|
|
|
3
|
+
import { useQuery } from './useQuery'
|
|
4
|
+
import { useInfiniteQuery } from './useInfiniteQuery'
|
|
5
|
+
import { useMutation } from './useMutation'
|
|
6
|
+
import { useQueries } from './useQueries'
|
|
7
|
+
|
|
8
|
+
import type {
|
|
9
|
+
DefinedUseBaseQueryResult,
|
|
10
|
+
DefinedUseInfiniteQueryResult,
|
|
11
|
+
DefinedUseQueryResult,
|
|
12
|
+
UseBaseMutationResult,
|
|
13
|
+
UseBaseQueryOptions,
|
|
14
|
+
UseBaseQueryResult,
|
|
15
|
+
UseInfiniteQueryOptions,
|
|
16
|
+
UseInfiniteQueryResult,
|
|
17
|
+
UseMutateAsyncFunction,
|
|
18
|
+
UseMutateFunction,
|
|
19
|
+
UseMutationOptions,
|
|
20
|
+
UseMutationResult,
|
|
21
|
+
UseQueryOptions,
|
|
22
|
+
UseQueryResult,
|
|
23
|
+
} from './types'
|
|
24
|
+
|
|
3
25
|
// Re-export core
|
|
4
26
|
export * from '@tanstack/query-core'
|
|
5
27
|
|
|
6
28
|
// Solid Query
|
|
7
29
|
export * from './types'
|
|
30
|
+
|
|
31
|
+
export type {
|
|
32
|
+
DefinedUseBaseQueryResult,
|
|
33
|
+
DefinedUseInfiniteQueryResult,
|
|
34
|
+
DefinedUseQueryResult,
|
|
35
|
+
SolidInfiniteQueryOptions,
|
|
36
|
+
SolidMutationOptions,
|
|
37
|
+
SolidQueryOptions,
|
|
38
|
+
UseBaseMutationResult,
|
|
39
|
+
UseBaseQueryOptions,
|
|
40
|
+
UseBaseQueryResult,
|
|
41
|
+
UseInfiniteQueryOptions,
|
|
42
|
+
UseInfiniteQueryResult,
|
|
43
|
+
UseMutateAsyncFunction,
|
|
44
|
+
UseMutateFunction,
|
|
45
|
+
UseMutationOptions,
|
|
46
|
+
UseMutationResult,
|
|
47
|
+
UseQueryOptions,
|
|
48
|
+
UseQueryResult,
|
|
49
|
+
} from './types'
|
|
50
|
+
|
|
51
|
+
// Compatibility types (deprecated)
|
|
52
|
+
/** @deprecated Use UseQueryOptions instead */
|
|
53
|
+
export type CreateQueryOptions = UseQueryOptions
|
|
54
|
+
/** @deprecated Use UseBaseQueryResult instead */
|
|
55
|
+
export type CreateBaseQueryResult = UseBaseQueryResult
|
|
56
|
+
/** @deprecated Use UseQueryResult instead */
|
|
57
|
+
export type CreateQueryResult = UseQueryResult
|
|
58
|
+
/** @deprecated Use DefinedUseBaseQueryResult instead */
|
|
59
|
+
export type DefinedCreateBaseQueryResult = DefinedUseBaseQueryResult
|
|
60
|
+
/** @deprecated Use DefinedUseQueryResult instead */
|
|
61
|
+
export type DefinedCreateQueryResult = DefinedUseQueryResult
|
|
62
|
+
/** @deprecated Use UseInfiniteQueryOptions instead */
|
|
63
|
+
export type CreateInfiniteQueryOptions = UseInfiniteQueryOptions
|
|
64
|
+
/** @deprecated Use UseInfiniteQueryResult instead */
|
|
65
|
+
export type CreateInfiniteQueryResult = UseInfiniteQueryResult
|
|
66
|
+
/** @deprecated Use DefinedUseInfiniteQueryResult instead */
|
|
67
|
+
export type DefinedCreateInfiniteQueryResult = DefinedUseInfiniteQueryResult
|
|
68
|
+
/** @deprecated Use UseMutationOptions instead */
|
|
69
|
+
export type CreateMutationOptions = UseMutationOptions
|
|
70
|
+
/** @deprecated Use UseMutateFunction instead */
|
|
71
|
+
export type CreateMutateFunction = UseMutateFunction
|
|
72
|
+
/** @deprecated Use UseMutateAsyncFunction instead */
|
|
73
|
+
export type CreateMutateAsyncFunction = UseMutateAsyncFunction
|
|
74
|
+
/** @deprecated Use UseBaseMutationResult instead */
|
|
75
|
+
export type CreateBaseMutationResult = UseBaseMutationResult
|
|
76
|
+
/** @deprecated Use UseMutationResult instead */
|
|
77
|
+
export type CreateMutationResult = UseMutationResult
|
|
78
|
+
/** @deprecated Use UseBaseQueryOptions instead */
|
|
79
|
+
export type CreateBaseQueryOptions = UseBaseQueryOptions
|
|
80
|
+
|
|
8
81
|
export { QueryClient } from './QueryClient'
|
|
9
82
|
export type {
|
|
10
83
|
QueryObserverOptions,
|
|
@@ -12,7 +85,9 @@ export type {
|
|
|
12
85
|
QueryClientConfig,
|
|
13
86
|
InfiniteQueryObserverOptions,
|
|
14
87
|
} from './QueryClient'
|
|
15
|
-
export {
|
|
88
|
+
export { useQuery } from './useQuery'
|
|
89
|
+
/** @deprecated Use useQuery instead */
|
|
90
|
+
export const createQuery = useQuery
|
|
16
91
|
export { queryOptions } from './queryOptions'
|
|
17
92
|
export type {
|
|
18
93
|
DefinedInitialDataOptions,
|
|
@@ -25,14 +100,20 @@ export {
|
|
|
25
100
|
} from './QueryClientProvider'
|
|
26
101
|
export type { QueryClientProviderProps } from './QueryClientProvider'
|
|
27
102
|
export { useIsFetching } from './useIsFetching'
|
|
28
|
-
export {
|
|
103
|
+
export { useInfiniteQuery }
|
|
104
|
+
/** @deprecated Use useInfiniteQuery instead */
|
|
105
|
+
export const createInfiniteQuery = useInfiniteQuery
|
|
29
106
|
export { infiniteQueryOptions } from './infiniteQueryOptions'
|
|
30
107
|
export type {
|
|
31
108
|
DefinedInitialDataInfiniteOptions,
|
|
32
109
|
UndefinedInitialDataInfiniteOptions,
|
|
33
110
|
} from './infiniteQueryOptions'
|
|
34
|
-
export {
|
|
111
|
+
export { useMutation } from './useMutation'
|
|
112
|
+
/** @deprecated Use useMutation instead */
|
|
113
|
+
export const createMutation = useMutation
|
|
35
114
|
export { useIsMutating } from './useIsMutating'
|
|
36
115
|
export { useMutationState } from './useMutationState'
|
|
37
|
-
export {
|
|
116
|
+
export { useQueries } from './useQueries'
|
|
117
|
+
/** @deprecated Use useQueries instead */
|
|
118
|
+
export const createQueries = useQueries
|
|
38
119
|
export { useIsRestoring, IsRestoringProvider } from './isRestoring'
|
package/src/types.ts
CHANGED
|
@@ -19,7 +19,7 @@ import type {
|
|
|
19
19
|
} from './QueryClient'
|
|
20
20
|
import type { Accessor } from 'solid-js'
|
|
21
21
|
|
|
22
|
-
export interface
|
|
22
|
+
export interface UseBaseQueryOptions<
|
|
23
23
|
TQueryFnData = unknown,
|
|
24
24
|
TError = DefaultError,
|
|
25
25
|
TData = TQueryFnData,
|
|
@@ -38,7 +38,7 @@ export interface CreateBaseQueryOptions<
|
|
|
38
38
|
deferStream?: boolean
|
|
39
39
|
/**
|
|
40
40
|
* @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
|
|
41
|
-
* The `data` property on
|
|
41
|
+
* The `data` property on useQuery is a SolidJS resource and will automatically suspend when the data is loading.
|
|
42
42
|
* Setting `suspense` to `false` will be a no-op.
|
|
43
43
|
*/
|
|
44
44
|
suspense?: boolean
|
|
@@ -49,7 +49,7 @@ export interface SolidQueryOptions<
|
|
|
49
49
|
TError = DefaultError,
|
|
50
50
|
TData = TQueryFnData,
|
|
51
51
|
TQueryKey extends QueryKey = QueryKey,
|
|
52
|
-
> extends
|
|
52
|
+
> extends UseBaseQueryOptions<
|
|
53
53
|
TQueryFnData,
|
|
54
54
|
TError,
|
|
55
55
|
TData,
|
|
@@ -57,7 +57,7 @@ export interface SolidQueryOptions<
|
|
|
57
57
|
TQueryKey
|
|
58
58
|
> {}
|
|
59
59
|
|
|
60
|
-
export type
|
|
60
|
+
export type UseQueryOptions<
|
|
61
61
|
TQueryFnData = unknown,
|
|
62
62
|
TError = DefaultError,
|
|
63
63
|
TData = TQueryFnData,
|
|
@@ -66,25 +66,25 @@ export type CreateQueryOptions<
|
|
|
66
66
|
|
|
67
67
|
/* --- Create Query and Create Base Query Types --- */
|
|
68
68
|
|
|
69
|
-
export type
|
|
69
|
+
export type UseBaseQueryResult<
|
|
70
70
|
TData = unknown,
|
|
71
71
|
TError = DefaultError,
|
|
72
72
|
> = QueryObserverResult<TData, TError>
|
|
73
73
|
|
|
74
|
-
export type
|
|
74
|
+
export type UseQueryResult<
|
|
75
75
|
TData = unknown,
|
|
76
76
|
TError = DefaultError,
|
|
77
|
-
> =
|
|
77
|
+
> = UseBaseQueryResult<TData, TError>
|
|
78
78
|
|
|
79
|
-
export type
|
|
79
|
+
export type DefinedUseBaseQueryResult<
|
|
80
80
|
TData = unknown,
|
|
81
81
|
TError = DefaultError,
|
|
82
82
|
> = DefinedQueryObserverResult<TData, TError>
|
|
83
83
|
|
|
84
|
-
export type
|
|
84
|
+
export type DefinedUseQueryResult<
|
|
85
85
|
TData = unknown,
|
|
86
86
|
TError = DefaultError,
|
|
87
|
-
> =
|
|
87
|
+
> = DefinedUseBaseQueryResult<TData, TError>
|
|
88
88
|
|
|
89
89
|
/* --- Create Infinite Queries Types --- */
|
|
90
90
|
export interface SolidInfiniteQueryOptions<
|
|
@@ -115,13 +115,13 @@ export interface SolidInfiniteQueryOptions<
|
|
|
115
115
|
deferStream?: boolean
|
|
116
116
|
/**
|
|
117
117
|
* @deprecated The `suspense` option has been deprecated in v5 and will be removed in the next major version.
|
|
118
|
-
* The `data` property on
|
|
118
|
+
* The `data` property on useInfiniteQuery is a SolidJS resource and will automatically suspend when the data is loading.
|
|
119
119
|
* Setting `suspense` to `false` will be a no-op.
|
|
120
120
|
*/
|
|
121
121
|
suspense?: boolean
|
|
122
122
|
}
|
|
123
123
|
|
|
124
|
-
export type
|
|
124
|
+
export type UseInfiniteQueryOptions<
|
|
125
125
|
TQueryFnData = unknown,
|
|
126
126
|
TError = DefaultError,
|
|
127
127
|
TData = TQueryFnData,
|
|
@@ -138,12 +138,12 @@ export type CreateInfiniteQueryOptions<
|
|
|
138
138
|
>
|
|
139
139
|
>
|
|
140
140
|
|
|
141
|
-
export type
|
|
141
|
+
export type UseInfiniteQueryResult<
|
|
142
142
|
TData = unknown,
|
|
143
143
|
TError = DefaultError,
|
|
144
144
|
> = InfiniteQueryObserverResult<TData, TError>
|
|
145
145
|
|
|
146
|
-
export type
|
|
146
|
+
export type DefinedUseInfiniteQueryResult<
|
|
147
147
|
TData = unknown,
|
|
148
148
|
TError = DefaultError,
|
|
149
149
|
> = DefinedInfiniteQueryObserverResult<TData, TError>
|
|
@@ -159,14 +159,14 @@ export interface SolidMutationOptions<
|
|
|
159
159
|
'_defaulted'
|
|
160
160
|
> {}
|
|
161
161
|
|
|
162
|
-
export type
|
|
162
|
+
export type UseMutationOptions<
|
|
163
163
|
TData = unknown,
|
|
164
164
|
TError = DefaultError,
|
|
165
165
|
TVariables = void,
|
|
166
166
|
TContext = unknown,
|
|
167
167
|
> = Accessor<SolidMutationOptions<TData, TError, TVariables, TContext>>
|
|
168
168
|
|
|
169
|
-
export type
|
|
169
|
+
export type UseMutateFunction<
|
|
170
170
|
TData = unknown,
|
|
171
171
|
TError = DefaultError,
|
|
172
172
|
TVariables = void,
|
|
@@ -175,28 +175,28 @@ export type CreateMutateFunction<
|
|
|
175
175
|
...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>
|
|
176
176
|
) => void
|
|
177
177
|
|
|
178
|
-
export type
|
|
178
|
+
export type UseMutateAsyncFunction<
|
|
179
179
|
TData = unknown,
|
|
180
180
|
TError = DefaultError,
|
|
181
181
|
TVariables = void,
|
|
182
182
|
TContext = unknown,
|
|
183
183
|
> = MutateFunction<TData, TError, TVariables, TContext>
|
|
184
184
|
|
|
185
|
-
export type
|
|
185
|
+
export type UseBaseMutationResult<
|
|
186
186
|
TData = unknown,
|
|
187
187
|
TError = DefaultError,
|
|
188
188
|
TVariables = unknown,
|
|
189
189
|
TContext = unknown,
|
|
190
190
|
> = Override<
|
|
191
191
|
MutationObserverResult<TData, TError, TVariables, TContext>,
|
|
192
|
-
{ mutate:
|
|
192
|
+
{ mutate: UseMutateFunction<TData, TError, TVariables, TContext> }
|
|
193
193
|
> & {
|
|
194
|
-
mutateAsync:
|
|
194
|
+
mutateAsync: UseMutateAsyncFunction<TData, TError, TVariables, TContext>
|
|
195
195
|
}
|
|
196
196
|
|
|
197
|
-
export type
|
|
197
|
+
export type UseMutationResult<
|
|
198
198
|
TData = unknown,
|
|
199
199
|
TError = DefaultError,
|
|
200
200
|
TVariables = unknown,
|
|
201
201
|
TContext = unknown,
|
|
202
|
-
> =
|
|
202
|
+
> = UseBaseMutationResult<TData, TError, TVariables, TContext>
|
|
@@ -15,7 +15,7 @@ import { createStore, reconcile, unwrap } from 'solid-js/store'
|
|
|
15
15
|
import { useQueryClient } from './QueryClientProvider'
|
|
16
16
|
import { shouldThrowError } from './utils'
|
|
17
17
|
import { useIsRestoring } from './isRestoring'
|
|
18
|
-
import type {
|
|
18
|
+
import type { UseBaseQueryOptions } from './types'
|
|
19
19
|
import type { Accessor, Signal } from 'solid-js'
|
|
20
20
|
import type { QueryClient } from './QueryClient'
|
|
21
21
|
import type {
|
|
@@ -101,7 +101,7 @@ const hydratableObserverResult = <
|
|
|
101
101
|
}
|
|
102
102
|
|
|
103
103
|
// Base Query Function that is used to create the query.
|
|
104
|
-
export function
|
|
104
|
+
export function useBaseQuery<
|
|
105
105
|
TQueryFnData,
|
|
106
106
|
TError,
|
|
107
107
|
TData,
|
|
@@ -109,7 +109,7 @@ export function createBaseQuery<
|
|
|
109
109
|
TQueryKey extends QueryKey,
|
|
110
110
|
>(
|
|
111
111
|
options: Accessor<
|
|
112
|
-
|
|
112
|
+
UseBaseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
|
|
113
113
|
>,
|
|
114
114
|
Observer: typeof QueryObserver,
|
|
115
115
|
queryClient?: Accessor<QueryClient>,
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { InfiniteQueryObserver } from '@tanstack/query-core'
|
|
2
2
|
import { createMemo } from 'solid-js'
|
|
3
|
-
import {
|
|
3
|
+
import { useBaseQuery } from './useBaseQuery'
|
|
4
4
|
import type {
|
|
5
5
|
DefaultError,
|
|
6
6
|
InfiniteData,
|
|
@@ -9,9 +9,9 @@ import type {
|
|
|
9
9
|
} from '@tanstack/query-core'
|
|
10
10
|
import type { QueryClient } from './QueryClient'
|
|
11
11
|
import type {
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
12
|
+
DefinedUseInfiniteQueryResult,
|
|
13
|
+
UseInfiniteQueryOptions,
|
|
14
|
+
UseInfiniteQueryResult,
|
|
15
15
|
} from './types'
|
|
16
16
|
import type { Accessor } from 'solid-js'
|
|
17
17
|
import type {
|
|
@@ -19,7 +19,7 @@ import type {
|
|
|
19
19
|
UndefinedInitialDataInfiniteOptions,
|
|
20
20
|
} from './infiniteQueryOptions'
|
|
21
21
|
|
|
22
|
-
export function
|
|
22
|
+
export function useInfiniteQuery<
|
|
23
23
|
TQueryFnData,
|
|
24
24
|
TError = DefaultError,
|
|
25
25
|
TData = InfiniteData<TQueryFnData>,
|
|
@@ -34,8 +34,8 @@ export function createInfiniteQuery<
|
|
|
34
34
|
TPageParam
|
|
35
35
|
>,
|
|
36
36
|
queryClient?: Accessor<QueryClient>,
|
|
37
|
-
):
|
|
38
|
-
export function
|
|
37
|
+
): DefinedUseInfiniteQueryResult<TData, TError>
|
|
38
|
+
export function useInfiniteQuery<
|
|
39
39
|
TQueryFnData,
|
|
40
40
|
TError = DefaultError,
|
|
41
41
|
TData = InfiniteData<TQueryFnData>,
|
|
@@ -50,16 +50,16 @@ export function createInfiniteQuery<
|
|
|
50
50
|
TPageParam
|
|
51
51
|
>,
|
|
52
52
|
queryClient?: Accessor<QueryClient>,
|
|
53
|
-
):
|
|
53
|
+
): UseInfiniteQueryResult<TData, TError>
|
|
54
54
|
|
|
55
|
-
export function
|
|
55
|
+
export function useInfiniteQuery<
|
|
56
56
|
TQueryFnData,
|
|
57
57
|
TError = DefaultError,
|
|
58
58
|
TData = InfiniteData<TQueryFnData>,
|
|
59
59
|
TQueryKey extends QueryKey = QueryKey,
|
|
60
60
|
TPageParam = unknown,
|
|
61
61
|
>(
|
|
62
|
-
options:
|
|
62
|
+
options: UseInfiniteQueryOptions<
|
|
63
63
|
TQueryFnData,
|
|
64
64
|
TError,
|
|
65
65
|
TData,
|
|
@@ -67,10 +67,10 @@ export function createInfiniteQuery<
|
|
|
67
67
|
TPageParam
|
|
68
68
|
>,
|
|
69
69
|
queryClient?: Accessor<QueryClient>,
|
|
70
|
-
):
|
|
71
|
-
return
|
|
70
|
+
): UseInfiniteQueryResult<TData, TError> {
|
|
71
|
+
return useBaseQuery(
|
|
72
72
|
createMemo(() => options()),
|
|
73
73
|
InfiniteQueryObserver as typeof QueryObserver,
|
|
74
74
|
queryClient,
|
|
75
|
-
) as
|
|
75
|
+
) as UseInfiniteQueryResult<TData, TError>
|
|
76
76
|
}
|
|
@@ -6,22 +6,22 @@ import { noop, shouldThrowError } from './utils'
|
|
|
6
6
|
import type { DefaultError } from '@tanstack/query-core'
|
|
7
7
|
import type { QueryClient } from './QueryClient'
|
|
8
8
|
import type {
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
9
|
+
UseMutateFunction,
|
|
10
|
+
UseMutationOptions,
|
|
11
|
+
UseMutationResult,
|
|
12
12
|
} from './types'
|
|
13
13
|
import type { Accessor } from 'solid-js'
|
|
14
14
|
|
|
15
15
|
// HOOK
|
|
16
|
-
export function
|
|
16
|
+
export function useMutation<
|
|
17
17
|
TData = unknown,
|
|
18
18
|
TError = DefaultError,
|
|
19
19
|
TVariables = void,
|
|
20
20
|
TContext = unknown,
|
|
21
21
|
>(
|
|
22
|
-
options:
|
|
22
|
+
options: UseMutationOptions<TData, TError, TVariables, TContext>,
|
|
23
23
|
queryClient?: Accessor<QueryClient>,
|
|
24
|
-
):
|
|
24
|
+
): UseMutationResult<TData, TError, TVariables, TContext> {
|
|
25
25
|
const client = createMemo(() => useQueryClient(queryClient?.()))
|
|
26
26
|
|
|
27
27
|
const observer = new MutationObserver<TData, TError, TVariables, TContext>(
|
|
@@ -29,7 +29,7 @@ export function createMutation<
|
|
|
29
29
|
options(),
|
|
30
30
|
)
|
|
31
31
|
|
|
32
|
-
const mutate:
|
|
32
|
+
const mutate: UseMutateFunction<TData, TError, TVariables, TContext> = (
|
|
33
33
|
variables,
|
|
34
34
|
mutateOptions,
|
|
35
35
|
) => {
|
|
@@ -37,7 +37,7 @@ export function createMutation<
|
|
|
37
37
|
}
|
|
38
38
|
|
|
39
39
|
const [state, setState] = createStore<
|
|
40
|
-
|
|
40
|
+
UseMutationResult<TData, TError, TVariables, TContext>
|
|
41
41
|
>({
|
|
42
42
|
...observer.getCurrentResult(),
|
|
43
43
|
mutate,
|