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

createInfiniteQuery.ts

116 lines2.9 KB

1import { InfiniteQueryObserver } from '@tanstack/query-core'
2import { createComputed } from 'solid-js'
3import { createStore } from 'solid-js/store'
4import { createBaseQuery } from './createBaseQuery'
5import { parseQueryArgs } from './utils'
6import type {
7 CreateInfiniteQueryOptions,
8 CreateInfiniteQueryResult,
9 SolidQueryKey,
10} from './types'
11import type {
12 QueryFunction,
13 QueryObserver,
14 QueryOptions,
15} from '@tanstack/query-core'
16​
17export function createInfiniteQuery<
18 TQueryFnData = unknown,
19 TError = unknown,
20 TData = TQueryFnData,
21 TQueryKey extends SolidQueryKey = SolidQueryKey,
22>(
23 options: CreateInfiniteQueryOptions<
24 TQueryFnData,
25 TError,
26 TData,
27 TQueryFnData,
28 TQueryKey
29 >,
30): CreateInfiniteQueryResult<TData, TError>
31export function createInfiniteQuery<
32 TQueryFnData = unknown,
33 TError = unknown,
34 TData = TQueryFnData,
35 TQueryKey extends SolidQueryKey = SolidQueryKey,
36>(
37 queryKey: TQueryKey,
38 options?: Omit<
39 CreateInfiniteQueryOptions<
40 TQueryFnData,
41 TError,
42 TData,
43 TQueryFnData,
44 TQueryKey
45 >,
46 'queryKey'
47 >,
48): CreateInfiniteQueryResult<TData, TError>
49export function createInfiniteQuery<
50 TQueryFnData = unknown,
51 TError = unknown,
52 TData = TQueryFnData,
53 TQueryKey extends SolidQueryKey = SolidQueryKey,
54>(
55 queryKey: TQueryKey,
56 queryFn: QueryFunction<TQueryFnData, ReturnType<TQueryKey>>,
57 options?: Omit<
58 CreateInfiniteQueryOptions<
59 TQueryFnData,
60 TError,
61 TData,
62 TQueryFnData,
63 TQueryKey
64 >,
65 'queryKey' | 'queryFn'
66 >,
67): CreateInfiniteQueryResult<TData, TError>
68export function createInfiniteQuery<
69 TQueryFnData,
70 TError,
71 TData = TQueryFnData,
72 TQueryKey extends SolidQueryKey = SolidQueryKey,
73>(
74 arg1:
75 | TQueryKey
76 | CreateInfiniteQueryOptions<
77 TQueryFnData,
78 TError,
79 TData,
80 TQueryFnData,
81 TQueryKey
82 >,
83 arg2?:
84 | QueryFunction<TQueryFnData, ReturnType<TQueryKey>>
85 | CreateInfiniteQueryOptions<
86 TQueryFnData,
87 TError,
88 TData,
89 TQueryFnData,
90 TQueryKey
91 >,
92 arg3?: CreateInfiniteQueryOptions<
93 TQueryFnData,
94 TError,
95 TData,
96 TQueryFnData,
97 TQueryKey
98 >,
99): CreateInfiniteQueryResult<TData, TError> {
100 // The parseQuery Args functions helps normalize the arguments into the correct form.
101 // Whatever the parameters are, they are normalized into the correct form.
102 const [parsedOptions, setParsedOptions] = createStore(
103 parseQueryArgs(arg1, arg2, arg3),
104 )
105​
106 // Watch for changes in the options and update the parsed options.
107 createComputed(() => {
108 const newParsedOptions = parseQueryArgs(arg1, arg2, arg3)
109 setParsedOptions(newParsedOptions)
110 })
111​
112 return createBaseQuery(
113 parsedOptions as QueryOptions<any, any, any, ReturnType<TQueryKey>>,
114 InfiniteQueryObserver as typeof QueryObserver,
115 ) as CreateInfiniteQueryResult<TData, TError>