@tanstack/query-core 5.0.0-beta.15 → 5.0.0-beta.20
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/legacy/hydration.cjs.map +1 -1
- package/build/legacy/hydration.d.cts +3 -3
- package/build/legacy/hydration.d.ts +3 -3
- package/build/legacy/hydration.js.map +1 -1
- package/build/legacy/index.d.cts +1 -1
- package/build/legacy/index.d.ts +1 -1
- package/build/legacy/infiniteQueryBehavior.cjs +1 -1
- package/build/legacy/infiniteQueryBehavior.cjs.map +1 -1
- package/build/legacy/infiniteQueryBehavior.d.cts +1 -1
- package/build/legacy/infiniteQueryBehavior.d.ts +1 -1
- package/build/legacy/infiniteQueryBehavior.js +1 -1
- package/build/legacy/infiniteQueryBehavior.js.map +1 -1
- package/build/legacy/infiniteQueryObserver.d.cts +1 -1
- package/build/legacy/infiniteQueryObserver.d.ts +1 -1
- package/build/legacy/mutation.cjs.map +1 -1
- package/build/legacy/mutation.d.cts +1 -1
- package/build/legacy/mutation.d.ts +1 -1
- package/build/legacy/mutation.js.map +1 -1
- package/build/legacy/mutationCache.cjs.map +1 -1
- package/build/legacy/mutationCache.d.cts +1 -1
- package/build/legacy/mutationCache.d.ts +1 -1
- package/build/legacy/mutationCache.js.map +1 -1
- package/build/legacy/mutationObserver.d.cts +1 -1
- package/build/legacy/mutationObserver.d.ts +1 -1
- package/build/legacy/notifyManager.cjs.map +1 -1
- package/build/legacy/notifyManager.d.cts +1 -1
- package/build/legacy/notifyManager.d.ts +1 -1
- package/build/legacy/notifyManager.js.map +1 -1
- package/build/legacy/queriesObserver.cjs +6 -8
- package/build/legacy/queriesObserver.cjs.map +1 -1
- package/build/legacy/queriesObserver.d.cts +11 -11
- package/build/legacy/queriesObserver.d.ts +11 -11
- package/build/legacy/queriesObserver.js +6 -8
- package/build/legacy/queriesObserver.js.map +1 -1
- package/build/legacy/query.cjs.map +1 -1
- package/build/legacy/query.d.cts +1 -1
- package/build/legacy/query.d.ts +1 -1
- package/build/legacy/query.js.map +1 -1
- package/build/legacy/queryCache.cjs.map +1 -1
- package/build/legacy/queryCache.d.cts +1 -1
- package/build/legacy/queryCache.d.ts +1 -1
- package/build/legacy/queryCache.js.map +1 -1
- package/build/legacy/{queryClient-6d6b4ed8.d.ts → queryClient-cc9406ab.d.ts} +19 -19
- package/build/legacy/{queryClient-58ec0ff3.d.ts → queryClient-f9f2d3d1.d.ts} +19 -19
- package/build/legacy/queryClient.cjs.map +1 -1
- package/build/legacy/queryClient.d.cts +1 -1
- package/build/legacy/queryClient.d.ts +1 -1
- package/build/legacy/queryClient.js.map +1 -1
- package/build/legacy/queryObserver.d.cts +1 -1
- package/build/legacy/queryObserver.d.ts +1 -1
- package/build/legacy/retryer.d.cts +1 -1
- package/build/legacy/retryer.d.ts +1 -1
- package/build/legacy/types.cjs.map +1 -1
- package/build/legacy/types.d.cts +1 -1
- package/build/legacy/types.d.ts +1 -1
- package/build/legacy/utils.cjs.map +1 -1
- package/build/legacy/utils.d.cts +1 -1
- package/build/legacy/utils.d.ts +1 -1
- package/build/legacy/utils.js.map +1 -1
- package/build/modern/hydration.cjs.map +1 -1
- package/build/modern/hydration.d.cts +3 -3
- package/build/modern/hydration.d.ts +3 -3
- package/build/modern/hydration.js.map +1 -1
- package/build/modern/index.d.cts +1 -1
- package/build/modern/index.d.ts +1 -1
- package/build/modern/infiniteQueryBehavior.cjs +1 -1
- package/build/modern/infiniteQueryBehavior.cjs.map +1 -1
- package/build/modern/infiniteQueryBehavior.d.cts +1 -1
- package/build/modern/infiniteQueryBehavior.d.ts +1 -1
- package/build/modern/infiniteQueryBehavior.js +1 -1
- package/build/modern/infiniteQueryBehavior.js.map +1 -1
- package/build/modern/infiniteQueryObserver.d.cts +1 -1
- package/build/modern/infiniteQueryObserver.d.ts +1 -1
- package/build/modern/mutation.cjs.map +1 -1
- package/build/modern/mutation.d.cts +1 -1
- package/build/modern/mutation.d.ts +1 -1
- package/build/modern/mutation.js.map +1 -1
- package/build/modern/mutationCache.cjs.map +1 -1
- package/build/modern/mutationCache.d.cts +1 -1
- package/build/modern/mutationCache.d.ts +1 -1
- package/build/modern/mutationCache.js.map +1 -1
- package/build/modern/mutationObserver.d.cts +1 -1
- package/build/modern/mutationObserver.d.ts +1 -1
- package/build/modern/notifyManager.cjs.map +1 -1
- package/build/modern/notifyManager.d.cts +1 -1
- package/build/modern/notifyManager.d.ts +1 -1
- package/build/modern/notifyManager.js.map +1 -1
- package/build/modern/queriesObserver.cjs +6 -8
- package/build/modern/queriesObserver.cjs.map +1 -1
- package/build/modern/queriesObserver.d.cts +11 -11
- package/build/modern/queriesObserver.d.ts +11 -11
- package/build/modern/queriesObserver.js +6 -8
- package/build/modern/queriesObserver.js.map +1 -1
- package/build/modern/query.cjs.map +1 -1
- package/build/modern/query.d.cts +1 -1
- package/build/modern/query.d.ts +1 -1
- package/build/modern/query.js.map +1 -1
- package/build/modern/queryCache.cjs.map +1 -1
- package/build/modern/queryCache.d.cts +1 -1
- package/build/modern/queryCache.d.ts +1 -1
- package/build/modern/queryCache.js.map +1 -1
- package/build/modern/{queryClient-6d6b4ed8.d.ts → queryClient-cc9406ab.d.ts} +19 -19
- package/build/modern/{queryClient-58ec0ff3.d.ts → queryClient-f9f2d3d1.d.ts} +19 -19
- package/build/modern/queryClient.cjs.map +1 -1
- package/build/modern/queryClient.d.cts +1 -1
- package/build/modern/queryClient.d.ts +1 -1
- package/build/modern/queryClient.js.map +1 -1
- package/build/modern/queryObserver.d.cts +1 -1
- package/build/modern/queryObserver.d.ts +1 -1
- package/build/modern/retryer.d.cts +1 -1
- package/build/modern/retryer.d.ts +1 -1
- package/build/modern/types.cjs.map +1 -1
- package/build/modern/types.d.cts +1 -1
- package/build/modern/types.d.ts +1 -1
- package/build/modern/utils.cjs.map +1 -1
- package/build/modern/utils.d.cts +1 -1
- package/build/modern/utils.d.ts +1 -1
- package/build/modern/utils.js.map +1 -1
- package/package.json +1 -1
- package/src/hydration.ts +2 -2
- package/src/infiniteQueryBehavior.ts +1 -1
- package/src/mutation.ts +1 -1
- package/src/mutationCache.ts +3 -3
- package/src/notifyManager.ts +3 -3
- package/src/queriesObserver.ts +24 -25
- package/src/query.ts +1 -1
- package/src/queryCache.ts +2 -2
- package/src/queryClient.ts +2 -2
- package/src/tests/hydration.test.tsx +2 -2
- package/src/tests/infiniteQueryBehavior.test.tsx +4 -4
- package/src/tests/infiniteQueryObserver.test.tsx +7 -7
- package/src/tests/mutations.test.tsx +2 -2
- package/src/tests/queriesObserver.test.tsx +4 -4
- package/src/tests/query.test.tsx +3 -3
- package/src/tests/queryClient.test.tsx +38 -38
- package/src/tests/queryObserver.test.tsx +19 -19
- package/src/tests/utils.test.tsx +2 -2
- package/src/types.ts +12 -12
- package/src/utils.ts +2 -2
|
@@ -584,7 +584,7 @@ describe('queryClient', () => {
|
|
|
584
584
|
StrictData,
|
|
585
585
|
StrictQueryKey,
|
|
586
586
|
number
|
|
587
|
-
>({ queryKey: key, queryFn: fetchFn,
|
|
587
|
+
>({ queryKey: key, queryFn: fetchFn, initialPageParam: 0 }),
|
|
588
588
|
).resolves.toEqual(data)
|
|
589
589
|
})
|
|
590
590
|
|
|
@@ -592,7 +592,7 @@ describe('queryClient', () => {
|
|
|
592
592
|
const key = queryKey()
|
|
593
593
|
const result = await queryClient.fetchInfiniteQuery({
|
|
594
594
|
queryKey: key,
|
|
595
|
-
|
|
595
|
+
initialPageParam: 10,
|
|
596
596
|
queryFn: ({ pageParam }) => Number(pageParam),
|
|
597
597
|
})
|
|
598
598
|
const result2 = queryClient.getQueryData(key)
|
|
@@ -622,7 +622,7 @@ describe('queryClient', () => {
|
|
|
622
622
|
StrictData,
|
|
623
623
|
StrictQueryKey,
|
|
624
624
|
number
|
|
625
|
-
>({ queryKey: key, queryFn: fetchFn,
|
|
625
|
+
>({ queryKey: key, queryFn: fetchFn, initialPageParam: 0 })
|
|
626
626
|
|
|
627
627
|
const result = queryClient.getQueryData(key)
|
|
628
628
|
|
|
@@ -638,7 +638,7 @@ describe('queryClient', () => {
|
|
|
638
638
|
await queryClient.prefetchInfiniteQuery({
|
|
639
639
|
queryKey: key,
|
|
640
640
|
queryFn: ({ pageParam }) => Number(pageParam),
|
|
641
|
-
|
|
641
|
+
initialPageParam: 10,
|
|
642
642
|
})
|
|
643
643
|
|
|
644
644
|
const result = queryClient.getQueryData(key)
|
|
@@ -657,7 +657,7 @@ describe('queryClient', () => {
|
|
|
657
657
|
queryFn: ({ pageParam }) => String(pageParam),
|
|
658
658
|
getNextPageParam: (_lastPage, _pages, lastPageParam) =>
|
|
659
659
|
lastPageParam + 5,
|
|
660
|
-
|
|
660
|
+
initialPageParam: 10,
|
|
661
661
|
pages: 3,
|
|
662
662
|
})
|
|
663
663
|
|
|
@@ -677,7 +677,7 @@ describe('queryClient', () => {
|
|
|
677
677
|
queryFn: ({ pageParam }) => String(pageParam),
|
|
678
678
|
getNextPageParam: (_lastPage, _pages, lastPageParam) =>
|
|
679
679
|
lastPageParam >= 20 ? undefined : lastPageParam + 5,
|
|
680
|
-
|
|
680
|
+
initialPageParam: 10,
|
|
681
681
|
pages: 5,
|
|
682
682
|
})
|
|
683
683
|
|
|
@@ -851,7 +851,7 @@ describe('queryClient', () => {
|
|
|
851
851
|
describe('refetchQueries', () => {
|
|
852
852
|
test('should not refetch if all observers are disabled', async () => {
|
|
853
853
|
const key = queryKey()
|
|
854
|
-
const queryFn = vi.fn<unknown
|
|
854
|
+
const queryFn = vi.fn<Array<unknown>, string>().mockReturnValue('data')
|
|
855
855
|
await queryClient.fetchQuery({ queryKey: key, queryFn })
|
|
856
856
|
const observer1 = new QueryObserver(queryClient, {
|
|
857
857
|
queryKey: key,
|
|
@@ -865,7 +865,7 @@ describe('queryClient', () => {
|
|
|
865
865
|
})
|
|
866
866
|
test('should refetch if at least one observer is enabled', async () => {
|
|
867
867
|
const key = queryKey()
|
|
868
|
-
const queryFn = vi.fn<unknown
|
|
868
|
+
const queryFn = vi.fn<Array<unknown>, string>().mockReturnValue('data')
|
|
869
869
|
await queryClient.fetchQuery({ queryKey: key, queryFn })
|
|
870
870
|
const observer1 = new QueryObserver(queryClient, {
|
|
871
871
|
queryKey: key,
|
|
@@ -887,8 +887,8 @@ describe('queryClient', () => {
|
|
|
887
887
|
test('should refetch all queries when no arguments are given', async () => {
|
|
888
888
|
const key1 = queryKey()
|
|
889
889
|
const key2 = queryKey()
|
|
890
|
-
const queryFn1 = vi.fn<unknown
|
|
891
|
-
const queryFn2 = vi.fn<unknown
|
|
890
|
+
const queryFn1 = vi.fn<Array<unknown>, string>().mockReturnValue('data1')
|
|
891
|
+
const queryFn2 = vi.fn<Array<unknown>, string>().mockReturnValue('data2')
|
|
892
892
|
await queryClient.fetchQuery({ queryKey: key1, queryFn: queryFn1 })
|
|
893
893
|
await queryClient.fetchQuery({ queryKey: key2, queryFn: queryFn2 })
|
|
894
894
|
const observer1 = new QueryObserver(queryClient, {
|
|
@@ -913,8 +913,8 @@ describe('queryClient', () => {
|
|
|
913
913
|
test('should be able to refetch all fresh queries', async () => {
|
|
914
914
|
const key1 = queryKey()
|
|
915
915
|
const key2 = queryKey()
|
|
916
|
-
const queryFn1 = vi.fn<unknown
|
|
917
|
-
const queryFn2 = vi.fn<unknown
|
|
916
|
+
const queryFn1 = vi.fn<Array<unknown>, string>().mockReturnValue('data1')
|
|
917
|
+
const queryFn2 = vi.fn<Array<unknown>, string>().mockReturnValue('data2')
|
|
918
918
|
await queryClient.fetchQuery({ queryKey: key1, queryFn: queryFn1 })
|
|
919
919
|
await queryClient.fetchQuery({ queryKey: key2, queryFn: queryFn2 })
|
|
920
920
|
const observer = new QueryObserver(queryClient, {
|
|
@@ -932,8 +932,8 @@ describe('queryClient', () => {
|
|
|
932
932
|
test('should be able to refetch all stale queries', async () => {
|
|
933
933
|
const key1 = queryKey()
|
|
934
934
|
const key2 = queryKey()
|
|
935
|
-
const queryFn1 = vi.fn<unknown
|
|
936
|
-
const queryFn2 = vi.fn<unknown
|
|
935
|
+
const queryFn1 = vi.fn<Array<unknown>, string>().mockReturnValue('data1')
|
|
936
|
+
const queryFn2 = vi.fn<Array<unknown>, string>().mockReturnValue('data2')
|
|
937
937
|
await queryClient.fetchQuery({ queryKey: key1, queryFn: queryFn1 })
|
|
938
938
|
await queryClient.fetchQuery({ queryKey: key2, queryFn: queryFn2 })
|
|
939
939
|
const observer = new QueryObserver(queryClient, {
|
|
@@ -952,8 +952,8 @@ describe('queryClient', () => {
|
|
|
952
952
|
test('should be able to refetch all stale and active queries', async () => {
|
|
953
953
|
const key1 = queryKey()
|
|
954
954
|
const key2 = queryKey()
|
|
955
|
-
const queryFn1 = vi.fn<unknown
|
|
956
|
-
const queryFn2 = vi.fn<unknown
|
|
955
|
+
const queryFn1 = vi.fn<Array<unknown>, string>().mockReturnValue('data1')
|
|
956
|
+
const queryFn2 = vi.fn<Array<unknown>, string>().mockReturnValue('data2')
|
|
957
957
|
await queryClient.fetchQuery({ queryKey: key1, queryFn: queryFn1 })
|
|
958
958
|
await queryClient.fetchQuery({ queryKey: key2, queryFn: queryFn2 })
|
|
959
959
|
queryClient.invalidateQueries({ queryKey: key1 })
|
|
@@ -974,8 +974,8 @@ describe('queryClient', () => {
|
|
|
974
974
|
test('should be able to refetch all active and inactive queries', async () => {
|
|
975
975
|
const key1 = queryKey()
|
|
976
976
|
const key2 = queryKey()
|
|
977
|
-
const queryFn1 = vi.fn<unknown
|
|
978
|
-
const queryFn2 = vi.fn<unknown
|
|
977
|
+
const queryFn1 = vi.fn<Array<unknown>, string>().mockReturnValue('data1')
|
|
978
|
+
const queryFn2 = vi.fn<Array<unknown>, string>().mockReturnValue('data2')
|
|
979
979
|
await queryClient.fetchQuery({ queryKey: key1, queryFn: queryFn1 })
|
|
980
980
|
await queryClient.fetchQuery({ queryKey: key2, queryFn: queryFn2 })
|
|
981
981
|
const observer = new QueryObserver(queryClient, {
|
|
@@ -993,8 +993,8 @@ describe('queryClient', () => {
|
|
|
993
993
|
test('should be able to refetch all active and inactive queries', async () => {
|
|
994
994
|
const key1 = queryKey()
|
|
995
995
|
const key2 = queryKey()
|
|
996
|
-
const queryFn1 = vi.fn<unknown
|
|
997
|
-
const queryFn2 = vi.fn<unknown
|
|
996
|
+
const queryFn1 = vi.fn<Array<unknown>, string>().mockReturnValue('data1')
|
|
997
|
+
const queryFn2 = vi.fn<Array<unknown>, string>().mockReturnValue('data2')
|
|
998
998
|
await queryClient.fetchQuery({ queryKey: key1, queryFn: queryFn1 })
|
|
999
999
|
await queryClient.fetchQuery({ queryKey: key2, queryFn: queryFn2 })
|
|
1000
1000
|
const observer = new QueryObserver(queryClient, {
|
|
@@ -1012,8 +1012,8 @@ describe('queryClient', () => {
|
|
|
1012
1012
|
test('should be able to refetch only active queries', async () => {
|
|
1013
1013
|
const key1 = queryKey()
|
|
1014
1014
|
const key2 = queryKey()
|
|
1015
|
-
const queryFn1 = vi.fn<unknown
|
|
1016
|
-
const queryFn2 = vi.fn<unknown
|
|
1015
|
+
const queryFn1 = vi.fn<Array<unknown>, string>().mockReturnValue('data1')
|
|
1016
|
+
const queryFn2 = vi.fn<Array<unknown>, string>().mockReturnValue('data2')
|
|
1017
1017
|
await queryClient.fetchQuery({ queryKey: key1, queryFn: queryFn1 })
|
|
1018
1018
|
await queryClient.fetchQuery({ queryKey: key2, queryFn: queryFn2 })
|
|
1019
1019
|
const observer = new QueryObserver(queryClient, {
|
|
@@ -1031,8 +1031,8 @@ describe('queryClient', () => {
|
|
|
1031
1031
|
test('should be able to refetch only inactive queries', async () => {
|
|
1032
1032
|
const key1 = queryKey()
|
|
1033
1033
|
const key2 = queryKey()
|
|
1034
|
-
const queryFn1 = vi.fn<unknown
|
|
1035
|
-
const queryFn2 = vi.fn<unknown
|
|
1034
|
+
const queryFn1 = vi.fn<Array<unknown>, string>().mockReturnValue('data1')
|
|
1035
|
+
const queryFn2 = vi.fn<Array<unknown>, string>().mockReturnValue('data2')
|
|
1036
1036
|
await queryClient.fetchQuery({ queryKey: key1, queryFn: queryFn1 })
|
|
1037
1037
|
await queryClient.fetchQuery({ queryKey: key2, queryFn: queryFn2 })
|
|
1038
1038
|
const observer = new QueryObserver(queryClient, {
|
|
@@ -1071,7 +1071,7 @@ describe('queryClient', () => {
|
|
|
1071
1071
|
|
|
1072
1072
|
test('should resolve Promise immediately if query is paused', async () => {
|
|
1073
1073
|
const key1 = queryKey()
|
|
1074
|
-
const queryFn1 = vi.fn<unknown
|
|
1074
|
+
const queryFn1 = vi.fn<Array<unknown>, string>().mockReturnValue('data1')
|
|
1075
1075
|
await queryClient.fetchQuery({ queryKey: key1, queryFn: queryFn1 })
|
|
1076
1076
|
const onlineMock = mockOnlineManagerIsOnline(false)
|
|
1077
1077
|
|
|
@@ -1085,7 +1085,7 @@ describe('queryClient', () => {
|
|
|
1085
1085
|
test('should refetch if query we are offline but query networkMode is always', async () => {
|
|
1086
1086
|
const key1 = queryKey()
|
|
1087
1087
|
queryClient.setQueryDefaults(key1, { networkMode: 'always' })
|
|
1088
|
-
const queryFn1 = vi.fn<unknown
|
|
1088
|
+
const queryFn1 = vi.fn<Array<unknown>, string>().mockReturnValue('data1')
|
|
1089
1089
|
await queryClient.fetchQuery({ queryKey: key1, queryFn: queryFn1 })
|
|
1090
1090
|
const onlineMock = mockOnlineManagerIsOnline(false)
|
|
1091
1091
|
|
|
@@ -1101,8 +1101,8 @@ describe('queryClient', () => {
|
|
|
1101
1101
|
test('should refetch active queries by default', async () => {
|
|
1102
1102
|
const key1 = queryKey()
|
|
1103
1103
|
const key2 = queryKey()
|
|
1104
|
-
const queryFn1 = vi.fn<unknown
|
|
1105
|
-
const queryFn2 = vi.fn<unknown
|
|
1104
|
+
const queryFn1 = vi.fn<Array<unknown>, string>().mockReturnValue('data1')
|
|
1105
|
+
const queryFn2 = vi.fn<Array<unknown>, string>().mockReturnValue('data2')
|
|
1106
1106
|
await queryClient.fetchQuery({ queryKey: key1, queryFn: queryFn1 })
|
|
1107
1107
|
await queryClient.fetchQuery({ queryKey: key2, queryFn: queryFn2 })
|
|
1108
1108
|
const observer = new QueryObserver(queryClient, {
|
|
@@ -1120,8 +1120,8 @@ describe('queryClient', () => {
|
|
|
1120
1120
|
test('should not refetch inactive queries by default', async () => {
|
|
1121
1121
|
const key1 = queryKey()
|
|
1122
1122
|
const key2 = queryKey()
|
|
1123
|
-
const queryFn1 = vi.fn<unknown
|
|
1124
|
-
const queryFn2 = vi.fn<unknown
|
|
1123
|
+
const queryFn1 = vi.fn<Array<unknown>, string>().mockReturnValue('data1')
|
|
1124
|
+
const queryFn2 = vi.fn<Array<unknown>, string>().mockReturnValue('data2')
|
|
1125
1125
|
await queryClient.fetchQuery({ queryKey: key1, queryFn: queryFn1 })
|
|
1126
1126
|
await queryClient.fetchQuery({ queryKey: key2, queryFn: queryFn2 })
|
|
1127
1127
|
const observer = new QueryObserver(queryClient, {
|
|
@@ -1139,8 +1139,8 @@ describe('queryClient', () => {
|
|
|
1139
1139
|
test('should not refetch active queries when "refetch" is "none"', async () => {
|
|
1140
1140
|
const key1 = queryKey()
|
|
1141
1141
|
const key2 = queryKey()
|
|
1142
|
-
const queryFn1 = vi.fn<unknown
|
|
1143
|
-
const queryFn2 = vi.fn<unknown
|
|
1142
|
+
const queryFn1 = vi.fn<Array<unknown>, string>().mockReturnValue('data1')
|
|
1143
|
+
const queryFn2 = vi.fn<Array<unknown>, string>().mockReturnValue('data2')
|
|
1144
1144
|
await queryClient.fetchQuery({ queryKey: key1, queryFn: queryFn1 })
|
|
1145
1145
|
await queryClient.fetchQuery({ queryKey: key2, queryFn: queryFn2 })
|
|
1146
1146
|
const observer = new QueryObserver(queryClient, {
|
|
@@ -1161,8 +1161,8 @@ describe('queryClient', () => {
|
|
|
1161
1161
|
test('should refetch inactive queries when "refetch" is "inactive"', async () => {
|
|
1162
1162
|
const key1 = queryKey()
|
|
1163
1163
|
const key2 = queryKey()
|
|
1164
|
-
const queryFn1 = vi.fn<unknown
|
|
1165
|
-
const queryFn2 = vi.fn<unknown
|
|
1164
|
+
const queryFn1 = vi.fn<Array<unknown>, string>().mockReturnValue('data1')
|
|
1165
|
+
const queryFn2 = vi.fn<Array<unknown>, string>().mockReturnValue('data2')
|
|
1166
1166
|
await queryClient.fetchQuery({ queryKey: key1, queryFn: queryFn1 })
|
|
1167
1167
|
await queryClient.fetchQuery({ queryKey: key2, queryFn: queryFn2 })
|
|
1168
1168
|
const observer = new QueryObserver(queryClient, {
|
|
@@ -1185,8 +1185,8 @@ describe('queryClient', () => {
|
|
|
1185
1185
|
test('should refetch active and inactive queries when "refetch" is "all"', async () => {
|
|
1186
1186
|
const key1 = queryKey()
|
|
1187
1187
|
const key2 = queryKey()
|
|
1188
|
-
const queryFn1 = vi.fn<unknown
|
|
1189
|
-
const queryFn2 = vi.fn<unknown
|
|
1188
|
+
const queryFn1 = vi.fn<Array<unknown>, string>().mockReturnValue('data1')
|
|
1189
|
+
const queryFn2 = vi.fn<Array<unknown>, string>().mockReturnValue('data2')
|
|
1190
1190
|
await queryClient.fetchQuery({ queryKey: key1, queryFn: queryFn1 })
|
|
1191
1191
|
await queryClient.fetchQuery({ queryKey: key2, queryFn: queryFn2 })
|
|
1192
1192
|
const observer = new QueryObserver(queryClient, {
|
|
@@ -1307,8 +1307,8 @@ describe('queryClient', () => {
|
|
|
1307
1307
|
test('should refetch all active queries', async () => {
|
|
1308
1308
|
const key1 = queryKey()
|
|
1309
1309
|
const key2 = queryKey()
|
|
1310
|
-
const queryFn1 = vi.fn<unknown
|
|
1311
|
-
const queryFn2 = vi.fn<unknown
|
|
1310
|
+
const queryFn1 = vi.fn<Array<unknown>, string>().mockReturnValue('data1')
|
|
1311
|
+
const queryFn2 = vi.fn<Array<unknown>, string>().mockReturnValue('data2')
|
|
1312
1312
|
const observer1 = new QueryObserver(queryClient, {
|
|
1313
1313
|
queryKey: key1,
|
|
1314
1314
|
queryFn: queryFn1,
|
|
@@ -17,7 +17,7 @@ describe('queryObserver', () => {
|
|
|
17
17
|
|
|
18
18
|
test('should trigger a fetch when subscribed', async () => {
|
|
19
19
|
const key = queryKey()
|
|
20
|
-
const queryFn = vi.fn<unknown
|
|
20
|
+
const queryFn = vi.fn<Array<unknown>, string>().mockReturnValue('data')
|
|
21
21
|
const observer = new QueryObserver(queryClient, { queryKey: key, queryFn })
|
|
22
22
|
const unsubscribe = observer.subscribe(() => undefined)
|
|
23
23
|
await sleep(1)
|
|
@@ -28,7 +28,7 @@ describe('queryObserver', () => {
|
|
|
28
28
|
test('should notify when switching query', async () => {
|
|
29
29
|
const key1 = queryKey()
|
|
30
30
|
const key2 = queryKey()
|
|
31
|
-
const results: QueryObserverResult
|
|
31
|
+
const results: Array<QueryObserverResult> = []
|
|
32
32
|
const observer = new QueryObserver(queryClient, {
|
|
33
33
|
queryKey: key1,
|
|
34
34
|
queryFn: () => 1,
|
|
@@ -113,7 +113,7 @@ describe('queryObserver', () => {
|
|
|
113
113
|
test('should run the selector again if the selector changed', async () => {
|
|
114
114
|
const key = queryKey()
|
|
115
115
|
let count = 0
|
|
116
|
-
const results: QueryObserverResult
|
|
116
|
+
const results: Array<QueryObserverResult> = []
|
|
117
117
|
const queryFn = () => ({ count: 1 })
|
|
118
118
|
const select1 = (data: ReturnType<typeof queryFn>) => {
|
|
119
119
|
count++
|
|
@@ -172,7 +172,7 @@ describe('queryObserver', () => {
|
|
|
172
172
|
test('should not run the selector again if the data and selector did not change', async () => {
|
|
173
173
|
const key = queryKey()
|
|
174
174
|
let count = 0
|
|
175
|
-
const results: QueryObserverResult
|
|
175
|
+
const results: Array<QueryObserverResult> = []
|
|
176
176
|
const queryFn = () => ({ count: 1 })
|
|
177
177
|
const select = (data: ReturnType<typeof queryFn>) => {
|
|
178
178
|
count++
|
|
@@ -239,7 +239,7 @@ describe('queryObserver', () => {
|
|
|
239
239
|
|
|
240
240
|
test('should always run the selector again if selector throws an error and selector is not referentially stable', async () => {
|
|
241
241
|
const key = queryKey()
|
|
242
|
-
const results: QueryObserverResult
|
|
242
|
+
const results: Array<QueryObserverResult> = []
|
|
243
243
|
const queryFn = async () => {
|
|
244
244
|
await sleep(10)
|
|
245
245
|
return { count: 1 }
|
|
@@ -281,7 +281,7 @@ describe('queryObserver', () => {
|
|
|
281
281
|
|
|
282
282
|
test('should return stale data if selector throws an error', async () => {
|
|
283
283
|
const key = queryKey()
|
|
284
|
-
const results: QueryObserverResult
|
|
284
|
+
const results: Array<QueryObserverResult> = []
|
|
285
285
|
let shouldError = false
|
|
286
286
|
const error = new Error('select error')
|
|
287
287
|
const observer = new QueryObserver(queryClient, {
|
|
@@ -349,7 +349,7 @@ describe('queryObserver', () => {
|
|
|
349
349
|
|
|
350
350
|
test('should not trigger a fetch when subscribed and disabled', async () => {
|
|
351
351
|
const key = queryKey()
|
|
352
|
-
const queryFn = vi.fn<unknown
|
|
352
|
+
const queryFn = vi.fn<Array<unknown>, string>().mockReturnValue('data')
|
|
353
353
|
const observer = new QueryObserver(queryClient, {
|
|
354
354
|
queryKey: key,
|
|
355
355
|
queryFn,
|
|
@@ -363,7 +363,7 @@ describe('queryObserver', () => {
|
|
|
363
363
|
|
|
364
364
|
test('should not trigger a fetch when not subscribed', async () => {
|
|
365
365
|
const key = queryKey()
|
|
366
|
-
const queryFn = vi.fn<unknown
|
|
366
|
+
const queryFn = vi.fn<Array<unknown>, string>().mockReturnValue('data')
|
|
367
367
|
new QueryObserver(queryClient, { queryKey: key, queryFn })
|
|
368
368
|
await sleep(1)
|
|
369
369
|
expect(queryFn).toHaveBeenCalledTimes(0)
|
|
@@ -371,7 +371,7 @@ describe('queryObserver', () => {
|
|
|
371
371
|
|
|
372
372
|
test('should be able to watch a query without defining a query function', async () => {
|
|
373
373
|
const key = queryKey()
|
|
374
|
-
const queryFn = vi.fn<unknown
|
|
374
|
+
const queryFn = vi.fn<Array<unknown>, string>().mockReturnValue('data')
|
|
375
375
|
const callback = vi.fn()
|
|
376
376
|
const observer = new QueryObserver(queryClient, {
|
|
377
377
|
queryKey: key,
|
|
@@ -386,12 +386,12 @@ describe('queryObserver', () => {
|
|
|
386
386
|
|
|
387
387
|
test('should accept unresolved query config in update function', async () => {
|
|
388
388
|
const key = queryKey()
|
|
389
|
-
const queryFn = vi.fn<unknown
|
|
389
|
+
const queryFn = vi.fn<Array<unknown>, string>().mockReturnValue('data')
|
|
390
390
|
const observer = new QueryObserver(queryClient, {
|
|
391
391
|
queryKey: key,
|
|
392
392
|
enabled: false,
|
|
393
393
|
})
|
|
394
|
-
const results: QueryObserverResult<unknown
|
|
394
|
+
const results: Array<QueryObserverResult<unknown>> = []
|
|
395
395
|
const unsubscribe = observer.subscribe((x) => {
|
|
396
396
|
results.push(x)
|
|
397
397
|
})
|
|
@@ -408,13 +408,13 @@ describe('queryObserver', () => {
|
|
|
408
408
|
|
|
409
409
|
test('should be able to handle multiple subscribers', async () => {
|
|
410
410
|
const key = queryKey()
|
|
411
|
-
const queryFn = vi.fn<unknown
|
|
411
|
+
const queryFn = vi.fn<Array<unknown>, string>().mockReturnValue('data')
|
|
412
412
|
const observer = new QueryObserver<string>(queryClient, {
|
|
413
413
|
queryKey: key,
|
|
414
414
|
enabled: false,
|
|
415
415
|
})
|
|
416
|
-
const results1: QueryObserverResult<string
|
|
417
|
-
const results2: QueryObserverResult<string
|
|
416
|
+
const results1: Array<QueryObserverResult<string>> = []
|
|
417
|
+
const results2: Array<QueryObserverResult<string>> = []
|
|
418
418
|
const unsubscribe1 = observer.subscribe((x) => {
|
|
419
419
|
results1.push(x)
|
|
420
420
|
})
|
|
@@ -490,7 +490,7 @@ describe('queryObserver', () => {
|
|
|
490
490
|
data: 'placeholder',
|
|
491
491
|
})
|
|
492
492
|
|
|
493
|
-
const results: QueryObserverResult<unknown
|
|
493
|
+
const results: Array<QueryObserverResult<unknown>> = []
|
|
494
494
|
|
|
495
495
|
const unsubscribe = observer.subscribe((x) => {
|
|
496
496
|
results.push(x)
|
|
@@ -568,7 +568,7 @@ describe('queryObserver', () => {
|
|
|
568
568
|
|
|
569
569
|
test('should not refetch in background if refetchIntervalInBackground is false', async () => {
|
|
570
570
|
const key = queryKey()
|
|
571
|
-
const queryFn = vi.fn<unknown
|
|
571
|
+
const queryFn = vi.fn<Array<unknown>, string>().mockReturnValue('data')
|
|
572
572
|
|
|
573
573
|
focusManager.setFocused(false)
|
|
574
574
|
const observer = new QueryObserver(queryClient, {
|
|
@@ -692,8 +692,8 @@ describe('queryObserver', () => {
|
|
|
692
692
|
})
|
|
693
693
|
|
|
694
694
|
test('should pass the correct previous queryKey (from prevQuery) to placeholderData function params with select', async () => {
|
|
695
|
-
const results: QueryObserverResult
|
|
696
|
-
const keys: Array<
|
|
695
|
+
const results: Array<QueryObserverResult> = []
|
|
696
|
+
const keys: Array<ReadonlyArray<unknown> | null> = []
|
|
697
697
|
|
|
698
698
|
const key1 = queryKey()
|
|
699
699
|
const key2 = queryKey()
|
|
@@ -758,7 +758,7 @@ describe('queryObserver', () => {
|
|
|
758
758
|
})
|
|
759
759
|
|
|
760
760
|
test('should pass the correct previous data to placeholderData function params when select function is used in conjunction', async () => {
|
|
761
|
-
const results: QueryObserverResult
|
|
761
|
+
const results: Array<QueryObserverResult> = []
|
|
762
762
|
|
|
763
763
|
const key1 = queryKey()
|
|
764
764
|
const key2 = queryKey()
|
package/src/tests/utils.test.tsx
CHANGED
|
@@ -173,8 +173,8 @@ describe('core/utils', () => {
|
|
|
173
173
|
})
|
|
174
174
|
|
|
175
175
|
it('should return the previous value when the next value is an equal empty array', () => {
|
|
176
|
-
const prev: any
|
|
177
|
-
const next: any
|
|
176
|
+
const prev: Array<any> = []
|
|
177
|
+
const next: Array<any> = []
|
|
178
178
|
expect(replaceEqualDeep(prev, next)).toBe(prev)
|
|
179
179
|
})
|
|
180
180
|
|
package/src/types.ts
CHANGED
|
@@ -19,7 +19,7 @@ export type DefaultError = Register extends {
|
|
|
19
19
|
? TError
|
|
20
20
|
: Error
|
|
21
21
|
|
|
22
|
-
export type QueryKey =
|
|
22
|
+
export type QueryKey = ReadonlyArray<unknown>
|
|
23
23
|
|
|
24
24
|
export type QueryFunction<
|
|
25
25
|
T = unknown,
|
|
@@ -68,21 +68,21 @@ export type QueryKeyHashFunction<TQueryKey extends QueryKey> = (
|
|
|
68
68
|
|
|
69
69
|
export type GetPreviousPageParamFunction<TPageParam, TQueryFnData = unknown> = (
|
|
70
70
|
firstPage: TQueryFnData,
|
|
71
|
-
allPages: TQueryFnData
|
|
71
|
+
allPages: Array<TQueryFnData>,
|
|
72
72
|
firstPageParam: TPageParam,
|
|
73
|
-
allPageParams: TPageParam
|
|
73
|
+
allPageParams: Array<TPageParam>,
|
|
74
74
|
) => TPageParam | undefined | null
|
|
75
75
|
|
|
76
76
|
export type GetNextPageParamFunction<TPageParam, TQueryFnData = unknown> = (
|
|
77
77
|
lastPage: TQueryFnData,
|
|
78
|
-
allPages: TQueryFnData
|
|
78
|
+
allPages: Array<TQueryFnData>,
|
|
79
79
|
lastPageParam: TPageParam,
|
|
80
|
-
allPageParams: TPageParam
|
|
80
|
+
allPageParams: Array<TPageParam>,
|
|
81
81
|
) => TPageParam | undefined | null
|
|
82
82
|
|
|
83
83
|
export interface InfiniteData<TData, TPageParam = unknown> {
|
|
84
|
-
pages: TData
|
|
85
|
-
pageParams: TPageParam
|
|
84
|
+
pages: Array<TData>
|
|
85
|
+
pageParams: Array<TPageParam>
|
|
86
86
|
}
|
|
87
87
|
|
|
88
88
|
export type QueryMeta = Register extends {
|
|
@@ -144,14 +144,14 @@ export interface QueryOptions<
|
|
|
144
144
|
maxPages?: number
|
|
145
145
|
}
|
|
146
146
|
|
|
147
|
-
export interface
|
|
148
|
-
|
|
147
|
+
export interface InitialPageParam<TPageParam = unknown> {
|
|
148
|
+
initialPageParam: TPageParam
|
|
149
149
|
}
|
|
150
150
|
|
|
151
151
|
export interface InfiniteQueryPageParamsOptions<
|
|
152
152
|
TQueryFnData = unknown,
|
|
153
153
|
TPageParam = unknown,
|
|
154
|
-
> extends
|
|
154
|
+
> extends InitialPageParam<TPageParam> {
|
|
155
155
|
/**
|
|
156
156
|
* This function can be set to automatically get the previous cursor for infinite queries.
|
|
157
157
|
* The result will also be used to determine the value of `hasPreviousPage`.
|
|
@@ -384,7 +384,7 @@ export type FetchInfiniteQueryOptions<
|
|
|
384
384
|
TQueryKey,
|
|
385
385
|
TPageParam
|
|
386
386
|
> &
|
|
387
|
-
|
|
387
|
+
InitialPageParam<TPageParam> &
|
|
388
388
|
FetchInfiniteQueryPages<TQueryFnData, TPageParam>
|
|
389
389
|
|
|
390
390
|
export interface ResultOptions {
|
|
@@ -606,7 +606,7 @@ export type InfiniteQueryObserverResult<
|
|
|
606
606
|
| InfiniteQueryObserverLoadingResult<TData, TError>
|
|
607
607
|
| DefinedInfiniteQueryObserverResult<TData, TError>
|
|
608
608
|
|
|
609
|
-
export type MutationKey =
|
|
609
|
+
export type MutationKey = ReadonlyArray<unknown>
|
|
610
610
|
|
|
611
611
|
export type MutationStatus = 'idle' | 'pending' | 'success' | 'error'
|
|
612
612
|
|
package/src/utils.ts
CHANGED
|
@@ -334,12 +334,12 @@ export function keepPreviousData<T>(
|
|
|
334
334
|
return previousData
|
|
335
335
|
}
|
|
336
336
|
|
|
337
|
-
export function addToEnd<T>(items: T
|
|
337
|
+
export function addToEnd<T>(items: Array<T>, item: T, max = 0): Array<T> {
|
|
338
338
|
const newItems = [...items, item]
|
|
339
339
|
return max && newItems.length > max ? newItems.slice(1) : newItems
|
|
340
340
|
}
|
|
341
341
|
|
|
342
|
-
export function addToStart<T>(items: T
|
|
342
|
+
export function addToStart<T>(items: Array<T>, item: T, max = 0): Array<T> {
|
|
343
343
|
const newItems = [item, ...items]
|
|
344
344
|
return max && newItems.length > max ? newItems.slice(0, -1) : newItems
|
|
345
345
|
}
|