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

createQuery.ts

100 lines2.7 KB

1import { QueryObserver } from '@tanstack/query-core'
2import { createMemo } from 'solid-js'
3import { createBaseQuery } from './createBaseQuery'
4import type { DefaultError, QueryKey } from '@tanstack/query-core'
5import type { QueryClient } from './QueryClient'
6import type { Accessor } from 'solid-js'
7import type {
8 CreateQueryOptions,
9 CreateQueryResult,
10 DefinedCreateQueryResult,
11 FunctionedParams,
12 SolidQueryOptions,
13} from './types'
14​
15type UndefinedInitialDataOptions<
16 TQueryFnData = unknown,
17 TError = DefaultError,
18 TData = TQueryFnData,
19 TQueryKey extends QueryKey = QueryKey,
20> = FunctionedParams<
21 SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
22 initialData?: undefined
23 }
25​
26type DefinedInitialDataOptions<
27 TQueryFnData = unknown,
28 TError = DefaultError,
29 TData = TQueryFnData,
30 TQueryKey extends QueryKey = QueryKey,
31> = FunctionedParams<
32 SolidQueryOptions<TQueryFnData, TError, TData, TQueryKey> & {
33 initialData: TQueryFnData | (() => TQueryFnData)
34 }
36​
37export function queryOptions<
38 TQueryFnData = unknown,
39 TError = unknown,
40 TData = TQueryFnData,
41 TQueryKey extends QueryKey = QueryKey,
42 TOptions extends UndefinedInitialDataOptions<
43 TQueryFnData,
44 TError,
45 TData,
46 TQueryKey
47 > = UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
48>(options: TOptions): TOptions
49​
50export function queryOptions<
51 TQueryFnData = unknown,
52 TError = unknown,
53 TData = TQueryFnData,
54 TQueryKey extends QueryKey = QueryKey,
55 TOptions extends DefinedInitialDataOptions<
56 TQueryFnData,
57 TError,
58 TData,
59 TQueryKey
60 > = DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
61>(options: TOptions): TOptions
62​
63export function queryOptions(options: unknown) {
64 return options
66​
67export function createQuery<
68 TQueryFnData = unknown,
69 TError = DefaultError,
70 TData = TQueryFnData,
71 TQueryKey extends QueryKey = QueryKey,
72>(
73 options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
74 queryClient?: () => QueryClient,
75): CreateQueryResult<TData, TError>
76​
77export function createQuery<
78 TQueryFnData = unknown,
79 TError = DefaultError,
80 TData = TQueryFnData,
81 TQueryKey extends QueryKey = QueryKey,
82>(
83 options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>,
84 queryClient?: () => QueryClient,
85): DefinedCreateQueryResult<TData, TError>
86export function createQuery<
87 TQueryFnData,
88 TError = DefaultError,
89 TData = TQueryFnData,
90 TQueryKey extends QueryKey = QueryKey,
91>(
92 options: CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>,
93 queryClient?: Accessor<QueryClient>,
94) {
95 return createBaseQuery(
96 createMemo(() => options()),
97 QueryObserver,
98 queryClient,
99 )