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

createQuery.md

72 lines1.7 KB

1---
2id: createQuery
3title: createQuery
4---
5​
6# Function: createQuery()
7​
8## createQuery(options, queryClient)
9​
10```ts
11function createQuery<TQueryFnData, TError, TData, TQueryKey>(
12 options,
13 queryClient?,
14): CreateQueryResult<TData, TError>
15```
16​
17### Type Parameters
18​
19β€’ **TQueryFnData** = `unknown`
20​
21β€’ **TError** = `Error`
22​
23β€’ **TData** = `TQueryFnData`
24​
25β€’ **TQueryKey** _extends_ `QueryKey` = `QueryKey`
26​
27### Parameters
28​
29β€’ **options**: [`StoreOrVal`](StoreOrVal.md)\<[`UndefinedInitialDataOptions`](UndefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>\>
30​
31β€’ **queryClient?**: `QueryClient`
32​
33### Returns
34​
35[`CreateQueryResult`](CreateQueryResult.md)\<`TData`, `TError`\>
36​
37### Defined in
38​
39[packages/svelte-query/src/createQuery.ts:15](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/createQuery.ts#L15)
40​
41## createQuery(options, queryClient)
42​
43```ts
44function createQuery<TQueryFnData, TError, TData, TQueryKey>(
45 options,
46 queryClient?,
47): DefinedCreateQueryResult<TData, TError>
48```
49​
50### Type Parameters
51​
52β€’ **TQueryFnData** = `unknown`
53​
54β€’ **TError** = `Error`
55​
56β€’ **TData** = `TQueryFnData`
57​
58β€’ **TQueryKey** _extends_ `QueryKey` = `QueryKey`
59​
60### Parameters
61​
62β€’ **options**: [`StoreOrVal`](StoreOrVal.md)\<[`DefinedInitialDataOptions`](DefinedInitialDataOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>\>
63​
64β€’ **queryClient?**: `QueryClient`
65​
66### Returns
67​
68[`DefinedCreateQueryResult`](DefinedCreateQueryResult.md)\<`TData`, `TError`\>
69​
70### Defined in
71​
72[packages/svelte-query/src/createQuery.ts:27](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/svelte-query/src/createQuery.ts#L27)