MCPcopy Create free account
hub / github.com/TanStack/query / usePrefetchQuery

Function usePrefetchQuery

packages/vue-query/src/usePrefetchQuery.ts:92–136  ·  view source on GitHub ↗
(
  options: MaybeRefOrGetter<
    MaybeRefDeep<
      UsePrefetchQueryOptions<
        TQueryFnData,
        TError,
        TData,
        TQueryData,
        TQueryKey
      >
    >
  >,
  queryClient?: QueryClient,
)

Source from the content-addressed store, hash-verified

90 * ```
91 */
92export function usePrefetchQuery<
93 TQueryFnData = unknown,
94 TError = DefaultError,
95 TData = TQueryFnData,
96 TQueryData = TQueryFnData,
97 TQueryKey extends QueryKey = QueryKey,
98>(
99 options: MaybeRefOrGetter<
100 MaybeRefDeep<
101 UsePrefetchQueryOptions<
102 TQueryFnData,
103 TError,
104 TData,
105 TQueryData,
106 TQueryKey
107 >
108 >
109 >,
110 queryClient?: QueryClient,
111): void {
112 if (process.env.NODE_ENV === 'development') {
113 if (!getCurrentScope()) {
114 console.warn(
115 'vue-query composable like "useQuery()" should only be used inside a "setup()" function or a running effect scope. They might otherwise lead to memory leaks.',
116 )
117 }
118 }
119
120 const client = queryClient || useQueryClient()
121
122 watchEffect(() => {
123 const resolvedOptions = isGetter(options) ? options() : unref(options)
124 const clonedOptions: UsePrefetchQueryOptions<
125 TQueryFnData,
126 TError,
127 TData,
128 TQueryData,
129 TQueryKey
130 > = cloneDeepUnref(resolvedOptions)
131
132 if (!client.getQueryState(clonedOptions.queryKey)) {
133 void client.query(clonedOptions).catch(noop)
134 }
135 })
136}

Calls 6

useQueryClientFunction · 0.90
cloneDeepUnrefFunction · 0.90
isGetterFunction · 0.70
optionsFunction · 0.50
getQueryStateMethod · 0.45
queryMethod · 0.45

Tested by

no test coverage detected