Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

useQueries.ts

176 lines6.0 KB

1import React, { useMemo } from 'react'
2import { QueryFunction } from '../core/types'
3​
4import { notifyManager } from '../core/notifyManager'
5import { QueriesObserver } from '../core/queriesObserver'
6import { useQueryClient } from './QueryClientProvider'
7import { UseQueryOptions, UseQueryResult } from './types'
8​
9// Avoid TS depth-limit error in case of large array literal
10type MAXIMUM_DEPTH = 20
11​
12type GetOptions<T extends any> =
13 // Part 1: responsible for applying explicit type parameter to function arguments, if object { queryFnData: TQueryFnData, error: TError, data: TData }
14 T extends {
15 queryFnData: infer TQueryFnData
16 error?: infer TError
17 data: infer TData
18 }
19 ? UseQueryOptions<TQueryFnData, TError, TData>
20 : T extends { queryFnData: infer TQueryFnData; error?: infer TError }
21 ? UseQueryOptions<TQueryFnData, TError>
22 : T extends { data: infer TData; error?: infer TError }
23 ? UseQueryOptions<unknown, TError, TData>
24 : // Part 2: responsible for applying explicit type parameter to function arguments, if tuple [TQueryFnData, TError, TData]
25 T extends [infer TQueryFnData, infer TError, infer TData]
26 ? UseQueryOptions<TQueryFnData, TError, TData>
27 : T extends [infer TQueryFnData, infer TError]
28 ? UseQueryOptions<TQueryFnData, TError>
29 : T extends [infer TQueryFnData]
30 ? UseQueryOptions<TQueryFnData>
31 : // Part 3: responsible for inferring and enforcing type if no explicit parameter was provided
32 T extends {
33 queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>
34 select: (data: any) => infer TData
35 }
36 ? UseQueryOptions<TQueryFnData, unknown, TData, TQueryKey>
37 : T extends { queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey> }
38 ? UseQueryOptions<TQueryFnData, unknown, TQueryFnData, TQueryKey>
39 : // Fallback
40 UseQueryOptions
41​
42type GetResults<T> =
43 // Part 1: responsible for mapping explicit type parameter to function result, if object
44 T extends { queryFnData: any; error?: infer TError; data: infer TData }
45 ? UseQueryResult<TData, TError>
46 : T extends { queryFnData: infer TQueryFnData; error?: infer TError }
47 ? UseQueryResult<TQueryFnData, TError>
48 : T extends { data: infer TData; error?: infer TError }
49 ? UseQueryResult<TData, TError>
50 : // Part 2: responsible for mapping explicit type parameter to function result, if tuple
51 T extends [any, infer TError, infer TData]
52 ? UseQueryResult<TData, TError>
53 : T extends [infer TQueryFnData, infer TError]
54 ? UseQueryResult<TQueryFnData, TError>
55 : T extends [infer TQueryFnData]
56 ? UseQueryResult<TQueryFnData>
57 : // Part 3: responsible for mapping inferred type to results, if no explicit parameter was provided
58 T extends {
59 queryFn?: QueryFunction<any, any>
60 select: (data: any) => infer TData
61 }
62 ? UseQueryResult<TData>
63 : T extends { queryFn?: QueryFunction<infer TQueryFnData, any> }
64 ? UseQueryResult<TQueryFnData>
65 : // Fallback
66 UseQueryResult
67​
68/**
69 * QueriesOptions reducer recursively unwraps function arguments to infer/enforce type param
70 */
71export type QueriesOptions<
72 T extends any[],
73 Result extends any[] = [],
74 Depth extends ReadonlyArray<number> = []
75> = Depth['length'] extends MAXIMUM_DEPTH
76 ? UseQueryOptions[]
77 : T extends []
78 ? []
79 : T extends [infer Head]
80 ? [...Result, GetOptions<Head>]
81 : T extends [infer Head, ...infer Tail]
82 ? QueriesOptions<[...Tail], [...Result, GetOptions<Head>], [...Depth, 1]>
83 : unknown[] extends T
84 ? T
85 : // If T is *some* array but we couldn't assign unknown[] to it, then it must hold some known/homogenous type!
86 // use this to infer the param types in the case of Array.map() argument
87 T extends UseQueryOptions<
88 infer TQueryFnData,
89 infer TError,
90 infer TData,
91 infer TQueryKey
92 >[]
93 ? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[]
94 : // Fallback
95 UseQueryOptions[]
96​
97/**
98 * QueriesResults reducer recursively maps type param to results
99 */
100export type QueriesResults<
101 T extends any[],
102 Result extends any[] = [],
103 Depth extends ReadonlyArray<number> = []
104> = Depth['length'] extends MAXIMUM_DEPTH
105 ? UseQueryResult[]
106 : T extends []
107 ? []
108 : T extends [infer Head]
109 ? [...Result, GetResults<Head>]
110 : T extends [infer Head, ...infer Tail]
111 ? QueriesResults<[...Tail], [...Result, GetResults<Head>], [...Depth, 1]>
112 : T extends UseQueryOptions<
113 infer TQueryFnData,
114 infer TError,
115 infer TData,
116 any
117 >[]
118 ? // Dynamic-size (homogenous) UseQueryOptions array: map directly to array of results
119 UseQueryResult<unknown extends TData ? TQueryFnData : TData, TError>[]
120 : // Fallback
121 UseQueryResult[]
122​
123export function useQueries<T extends any[]>(
124 queries: readonly [...QueriesOptions<T>]
125): QueriesResults<T> {
126 const mountedRef = React.useRef(false)
127 const [, forceUpdate] = React.useState(0)
128​
129 const queryClient = useQueryClient()
130​
131 const defaultedQueries = useMemo(
132 () =>
133 queries.map(options => {
134 const defaultedOptions = queryClient.defaultQueryObserverOptions(
135 options
136 )
137​
138 // Make sure the results are already in fetching state before subscribing or updating options
139 defaultedOptions.optimisticResults = true
140​
141 return defaultedOptions
142 }),
143 [queries, queryClient]
144 )
145​
146 const [observer] = React.useState(
147 () => new QueriesObserver(queryClient, defaultedQueries)
148 )
149​
150 const result = observer.getOptimisticResult(defaultedQueries)
151​
152 React.useEffect(() => {
153 mountedRef.current = true
154​
155 const unsubscribe = observer.subscribe(
156 notifyManager.batchCalls(() => {
157 if (mountedRef.current) {
158 forceUpdate(x => x + 1)
159 }
160 })
161 )
162​
163 return () => {
164 mountedRef.current = false
165 unsubscribe()
166 }
167 }, [observer])
168​
169 React.useEffect(() => {
170 // Do not notify on updates because of changes in the options because
171 // these changes should already be reflected in the optimistic result.
172 observer.setQueries(defaultedQueries, { listeners: false })
173 }, [defaultedQueries, observer])
174​
175 return result as QueriesResults<T>