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

createQuery.ts

157 lines5.1 KB

1import { QueryObserver } from '@tanstack/query-core'
2import { createComputed } from 'solid-js'
3import { createStore } from 'solid-js/store'
4import { parseQueryArgs } from './utils'
5import { createBaseQuery } from './createBaseQuery'
6import type {
7 CreateQueryOptions,
8 CreateQueryResult,
9 DefinedCreateQueryResult,
10 SolidQueryKey,
11} from './types'
12import type { QueryFunction, QueryOptions } from '@tanstack/query-core'
13​
14// There are several ways to create a query.
15// 1. createQuery(options: CreateQueryOptions)
16// 2. createQuery(querykey: () => Serializable[], options: CreateQueryOptions)
17// 3. createQuery(querykey: () => Serializable[], queryFunc: Fetcher Function, options: CreateQueryOptions)
18// 4. The fourth overload is a combination of all three function params
19export function createQuery<
20 TQueryFnData = unknown,
21 TError = unknown,
22 TData = TQueryFnData,
23 TQueryKey extends SolidQueryKey = SolidQueryKey,
24>(
25 options: Omit<
26 CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
27 'initialData'
28 > & {
29 initialData?: () => undefined
30 },
31): CreateQueryResult<TData, TError>
32export function createQuery<
33 TQueryFnData = unknown,
34 TError = unknown,
35 TData = TQueryFnData,
36 TQueryKey extends SolidQueryKey = SolidQueryKey,
37>(
38 options: Omit<
39 CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
40 'initialData'
41 > & {
42 initialData: TQueryFnData | (() => TQueryFnData)
43 },
44): DefinedCreateQueryResult<TData, TError>
45export function createQuery<
46 TQueryFnData = unknown,
47 TError = unknown,
48 TData = TQueryFnData,
49 TQueryKey extends SolidQueryKey = SolidQueryKey,
50>(
51 options: CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
52): CreateQueryResult<TData, TError>
53export function createQuery<
54 TQueryFnData = unknown,
55 TError = unknown,
56 TData = TQueryFnData,
57 TQueryKey extends SolidQueryKey = SolidQueryKey,
58>(
59 queryKey: TQueryKey,
60 options?: Omit<
61 CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
62 'queryKey' | 'initialData'
63 > & { initialData?: () => undefined },
64): CreateQueryResult<TData, TError>
65export function createQuery<
66 TQueryFnData = unknown,
67 TError = unknown,
68 TData = TQueryFnData,
69 TQueryKey extends SolidQueryKey = SolidQueryKey,
70>(
71 queryKey: TQueryKey,
72 options?: Omit<
73 CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
74 'queryKey' | 'initialData'
75 > & { initialData: TQueryFnData | (() => TQueryFnData) },
76): DefinedCreateQueryResult<TData, TError>
77export function createQuery<
78 TQueryFnData = unknown,
79 TError = unknown,
80 TData = TQueryFnData,
81 TQueryKey extends SolidQueryKey = SolidQueryKey,
82>(
83 queryKey: TQueryKey,
84 options?: Omit<
85 CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
86 'queryKey'
87 >,
88): CreateQueryResult<TData, TError>
89export function createQuery<
90 TQueryFnData = unknown,
91 TError = unknown,
92 TData = TQueryFnData,
93 TQueryKey extends SolidQueryKey = SolidQueryKey,
94>(
95 queryKey: TQueryKey,
96 // TODO(lukemurray): not sure if we want to use return type here
97 queryFn: QueryFunction<TQueryFnData, ReturnType<TQueryKey>>,
98 options?: Omit<
99 CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
100 'queryKey' | 'queryFn' | 'initialData'
101 > & { initialData?: () => undefined },
102): CreateQueryResult<TData, TError>
103export function createQuery<
104 TQueryFnData = unknown,
105 TError = unknown,
106 TData = TQueryFnData,
107 TQueryKey extends SolidQueryKey = SolidQueryKey,
108>(
109 queryKey: TQueryKey,
110 queryFn: QueryFunction<TQueryFnData, ReturnType<TQueryKey>>,
111 options?: Omit<
112 CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
113 'queryKey' | 'queryFn' | 'initialData'
114 > & { initialData: TQueryFnData | (() => TQueryFnData) },
115): DefinedCreateQueryResult<TData, TError>
116export function createQuery<
117 TQueryFnData = unknown,
118 TError = unknown,
119 TData = TQueryFnData,
120 TQueryKey extends SolidQueryKey = SolidQueryKey,
121>(
122 queryKey: TQueryKey,
123 queryFn: QueryFunction<TQueryFnData, ReturnType<TQueryKey>>,
124 options?: Omit<
125 CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
126 'queryKey' | 'queryFn'
127 >,
128): CreateQueryResult<TData, TError>
129export function createQuery<
130 TQueryFnData,
131 TError,
132 TData = TQueryFnData,
133 TQueryKey extends SolidQueryKey = SolidQueryKey,
134>(
135 arg1: TQueryKey | CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
136 arg2?:
137 | QueryFunction<TQueryFnData, ReturnType<TQueryKey>>
138 | CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
139 arg3?: CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
140): CreateQueryResult<TData, TError> {
141 // The parseQuery Args functions helps normalize the arguments into the correct form.
142 // Whatever the parameters are, they are normalized into the correct form.
143 const [parsedOptions, setParsedOptions] = createStore(
144 parseQueryArgs(arg1, arg2, arg3),
145 )
146​
147 // Watch for changes in the options and update the parsed options.
148 createComputed(() => {
149 const newParsedOptions = parseQueryArgs(arg1, arg2, arg3)
150 setParsedOptions(newParsedOptions)
151 })
152​
153 return createBaseQuery(
154 parsedOptions as QueryOptions<any, any, any, ReturnType<TQueryKey>>,
155 QueryObserver,
156 )