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

Function createBaseQuery

packages/svelte-query/src/createBaseQuery.svelte.ts:20–135  ·  view source on GitHub ↗
(
  options: Accessor<
    CreateBaseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
  >,
  Observer: typeof QueryObserver,
  queryClient?: Accessor<QueryClient>,
)

Source from the content-addressed store, hash-verified

18 * @returns The reactive query result.
19 */
20export function createBaseQuery<
21 TQueryFnData,
22 TError,
23 TData,
24 TQueryData,
25 TQueryKey extends QueryKey,
26>(
27 options: Accessor<
28 CreateBaseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>
29 >,
30 Observer: typeof QueryObserver,
31 queryClient?: Accessor<QueryClient>,
32): CreateBaseQueryResult<TData, TError> {
33 /** Load query client */
34 const client = $derived(useQueryClient(queryClient?.()))
35 const isRestoring = useIsRestoring()
36
37 const resolvedOptions = $derived.by(() => {
38 const opts = client.defaultQueryOptions(options())
39 opts._optimisticResults = isRestoring.current ? 'isRestoring' : 'optimistic'
40 return opts
41 })
42
43 /** Creates the observer */
44 // svelte-ignore state_referenced_locally - intentional, initial value
45 let observer = $state(
46 new Observer<TQueryFnData, TError, TData, TQueryData, TQueryKey>(
47 client,
48 resolvedOptions,
49 ),
50 )
51 watchChanges(
52 () => client,
53 'pre',
54 () => {
55 observer = new Observer<
56 TQueryFnData,
57 TError,
58 TData,
59 TQueryData,
60 TQueryKey
61 >(client, resolvedOptions)
62 },
63 )
64
65 /**
66 * Computes the observer's current result for the resolved options, tracking property access unless
67 * `notifyOnChangeProps` is set.
68 * @returns The current query result.
69 */
70 function createResult() {
71 const result = observer.getOptimisticResult(resolvedOptions)
72 return !resolvedOptions.notifyOnChangeProps
73 ? observer.trackResult(result)
74 : result
75 }
76 const [query, update] = createRawRef(
77 // svelte-ignore state_referenced_locally - intentional, initial value

Callers 2

createInfiniteQueryFunction · 0.85
createQueryFunction · 0.85

Calls 12

watchChangesFunction · 0.85
createRawRefFunction · 0.85
updateFunction · 0.85
defaultQueryOptionsMethod · 0.80
updateResultMethod · 0.80
useQueryClientFunction · 0.70
useIsRestoringFunction · 0.70
createResultFunction · 0.70
optionsFunction · 0.50
unsubscribeFunction · 0.50
subscribeMethod · 0.45
setOptionsMethod · 0.45

Tested by

no test coverage detected