@@ -14,70 +14,70 @@ useQuery and friends used to have many overloads in TypeScript - different ways
14
14
now we only support the object format.
15
15
16
16
``` tsx
17
- useQuery (key , fn , options ) + // [!code --]
18
- useQuery ({ queryKey , queryFn , ... options }) - // [!code ++]
19
- useInfiniteQuery (key , fn , options ) + // [!code --]
20
- useInfiniteQuery ({ queryKey , queryFn , ... options }) - // [!code ++]
21
- useMutation (fn , options ) + // [!code --]
22
- useMutation ({ mutationFn , ... options }) - // [!code ++]
23
- useIsFetching (key , filters ) + // [!code --]
24
- useIsFetching ({ queryKey , ... filters }) - // [!code ++]
25
- useIsMutating (key , filters ) + // [!code --]
26
- useIsMutating ({ mutationKey , ... filters }) // [!code ++]
17
+ useQuery (key , fn , options ) // [!code --]
18
+ useQuery ({ queryKey , queryFn , ... options }) // [!code ++]
19
+ useInfiniteQuery (key , fn , options ) // [!code --]
20
+ useInfiniteQuery ({ queryKey , queryFn , ... options }) // [!code ++]
21
+ useMutation (fn , options ) // [!code --]
22
+ useMutation ({ mutationFn , ... options }) // [!code ++]
23
+ useIsFetching (key , filters ) // [!code --]
24
+ useIsFetching ({ queryKey , ... filters }) // [!code ++]
25
+ useIsMutating (key , filters ) // [!code --]
26
+ useIsMutating ({ mutationKey , ... filters }) // [!code ++]
27
27
```
28
28
29
29
``` tsx
30
- queryClient .isFetching (key , filters ) + // [!code --]
31
- queryClient .isFetching ({ queryKey , ... filters }) - // [!code ++]
32
- queryClient .ensureQueryData (key , filters ) + // [!code --]
33
- queryClient .ensureQueryData ({ queryKey , ... filters }) - // [!code ++]
34
- queryClient .getQueriesData (key , filters ) + // [!code --]
35
- queryClient .getQueriesData ({ queryKey , ... filters }) - // [!code ++]
36
- queryClient .setQueriesData (key , updater , filters , options ) + // [!code --]
37
- queryClient .setQueriesData ({ queryKey , ... filters }, updater , options ) - // [!code ++]
38
- queryClient .removeQueries (key , filters ) + // [!code --]
39
- queryClient .removeQueries ({ queryKey , ... filters }) - // [!code ++]
40
- queryClient .resetQueries (key , filters , options ) + // [!code --]
41
- queryClient .resetQueries ({ queryKey , ... filters }, options ) - // [!code ++]
42
- queryClient .cancelQueries (key , filters , options ) + // [!code --]
43
- queryClient .cancelQueries ({ queryKey , ... filters }, options ) - // [!code ++]
44
- queryClient .invalidateQueries (key , filters , options ) + // [!code --]
45
- queryClient .invalidateQueries ({ queryKey , ... filters }, options ) - // [!code ++]
46
- queryClient .refetchQueries (key , filters , options ) + // [!code --]
47
- queryClient .refetchQueries ({ queryKey , ... filters }, options ) - // [!code ++]
48
- queryClient .fetchQuery (key , fn , options ) + // [!code --]
49
- queryClient .fetchQuery ({ queryKey , queryFn , ... options }) - // [!code ++]
50
- queryClient .prefetchQuery (key , fn , options ) + // [!code --]
51
- queryClient .prefetchQuery ({ queryKey , queryFn , ... options }) - // [!code ++]
52
- queryClient .fetchInfiniteQuery (key , fn , options ) + // [!code --]
53
- queryClient .fetchInfiniteQuery ({ queryKey , queryFn , ... options }) - // [!code ++]
54
- queryClient .prefetchInfiniteQuery (key , fn , options ) + // [!code --]
55
- queryClient .prefetchInfiniteQuery ({ queryKey , queryFn , ... options }) // [!code ++]
30
+ queryClient .isFetching (key , filters ) // [!code --]
31
+ queryClient .isFetching ({ queryKey , ... filters }) // [!code ++]
32
+ queryClient .ensureQueryData (key , filters ) // [!code --]
33
+ queryClient .ensureQueryData ({ queryKey , ... filters }) // [!code ++]
34
+ queryClient .getQueriesData (key , filters ) // [!code --]
35
+ queryClient .getQueriesData ({ queryKey , ... filters }) // [!code ++]
36
+ queryClient .setQueriesData (key , updater , filters , options ) // [!code --]
37
+ queryClient .setQueriesData ({ queryKey , ... filters }, updater , options ) // [!code ++]
38
+ queryClient .removeQueries (key , filters ) // [!code --]
39
+ queryClient .removeQueries ({ queryKey , ... filters }) // [!code ++]
40
+ queryClient .resetQueries (key , filters , options ) // [!code --]
41
+ queryClient .resetQueries ({ queryKey , ... filters }, options ) // [!code ++]
42
+ queryClient .cancelQueries (key , filters , options ) // [!code --]
43
+ queryClient .cancelQueries ({ queryKey , ... filters }, options ) // [!code ++]
44
+ queryClient .invalidateQueries (key , filters , options ) // [!code --]
45
+ queryClient .invalidateQueries ({ queryKey , ... filters }, options ) // [!code ++]
46
+ queryClient .refetchQueries (key , filters , options ) // [!code --]
47
+ queryClient .refetchQueries ({ queryKey , ... filters }, options ) // [!code ++]
48
+ queryClient .fetchQuery (key , fn , options ) // [!code --]
49
+ queryClient .fetchQuery ({ queryKey , queryFn , ... options }) // [!code ++]
50
+ queryClient .prefetchQuery (key , fn , options ) // [!code --]
51
+ queryClient .prefetchQuery ({ queryKey , queryFn , ... options }) // [!code ++]
52
+ queryClient .fetchInfiniteQuery (key , fn , options ) // [!code --]
53
+ queryClient .fetchInfiniteQuery ({ queryKey , queryFn , ... options }) // [!code ++]
54
+ queryClient .prefetchInfiniteQuery (key , fn , options ) // [!code --]
55
+ queryClient .prefetchInfiniteQuery ({ queryKey , queryFn , ... options }) // [!code ++]
56
56
```
57
57
58
58
``` tsx
59
- queryCache .find (key , filters ) + // [!code --]
60
- queryCache .find ({ queryKey , ... filters }) - // [!code ++]
61
- queryCache .findAll (key , filters ) + // [!code --]
62
- queryCache .findAll ({ queryKey , ... filters }) // [!code ++]
59
+ queryCache .find (key , filters ) // [!code --]
60
+ queryCache .find ({ queryKey , ... filters }) // [!code ++]
61
+ queryCache .findAll (key , filters ) // [!code --]
62
+ queryCache .findAll ({ queryKey , ... filters }) // [!code ++]
63
63
```
64
64
65
65
### ` queryClient.getQueryData ` now accepts queryKey only as an Argument
66
66
67
67
` queryClient.getQueryData ` argument is changed to accept only a ` queryKey `
68
68
69
69
``` tsx
70
- queryClient .getQueryData (queryKey , filters ) + // [!code --]
71
- queryClient .getQueryData (queryKey ) // [!code ++]
70
+ queryClient .getQueryData (queryKey , filters ) // [!code --]
71
+ queryClient .getQueryData (queryKey ) // [!code ++]
72
72
```
73
73
74
74
### ` queryClient.getQueryState ` now accepts queryKey only as an Argument
75
75
76
76
` queryClient.getQueryState ` argument is changed to accept only a ` queryKey `
77
77
78
78
``` tsx
79
- queryClient .getQueryState (queryKey , filters ) + // [!code --]
80
- queryClient .getQueryState (queryKey ) // [!code ++]
79
+ queryClient .getQueryState (queryKey , filters ) // [!code --]
80
+ queryClient .getQueryState (queryKey ) // [!code ++]
81
81
```
82
82
83
83
#### Codemod
@@ -142,8 +142,8 @@ if you still need to remove a query, you can use `queryClient.removeQueries({que
142
142
const queryClient = useQueryClient ()
143
143
const query = useQuery ({ queryKey , queryFn })
144
144
145
- query .remove () + // [!code --]
146
- queryClient .removeQueries ({ queryKey }) // [!code ++]
145
+ query .remove () // [!code --]
146
+ queryClient .removeQueries ({ queryKey }) // [!code ++]
147
147
```
148
148
149
149
### The minimum required TypeScript version is now 4.7
0 commit comments