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

QueryCollectionConfig.md

206 lines4.3 KB

1---
2id: QueryCollectionConfig
3title: QueryCollectionConfig
4---
5​
6# Interface: QueryCollectionConfig\<T, TQueryFn, TError, TQueryKey, TKey, TSchema, TQueryData\>
7​
8Defined in: [packages/query-db-collection/src/query.ts:61](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L61)
9​
10Configuration options for creating a Query Collection
11​
12## Extends
13​
14- `BaseCollectionConfig`\<`T`, `TKey`, `TSchema`\>
15​
16## Type Parameters
17​
18### T
19​
20`T` *extends* `object` = `object`
21​
22The explicit type of items stored in the collection
23​
24### TQueryFn
25​
26`TQueryFn` *extends* (`context`) => `any` = (`context`) => `any`
27​
28The queryFn type
29​
30### TError
31​
32`TError` = `unknown`
33​
34The type of errors that can occur during queries
35​
36### TQueryKey
37​
38`TQueryKey` *extends* `QueryKey` = `QueryKey`
39​
40The type of the query key
41​
42### TKey
43​
44`TKey` *extends* `string` \| `number` = `string` \| `number`
45​
46The type of the item keys
47​
48### TSchema
49​
50`TSchema` *extends* `StandardSchemaV1` = `never`
51​
52The schema type for validation
53​
54### TQueryData
55​
56`TQueryData` = `Awaited`\<`ReturnType`\<`TQueryFn`\>\>
57​
58## Properties
59​
60### enabled?
61​
62```ts
63optional enabled: Enabled<TQueryData, TError, TQueryData, TQueryKey>;
64```
65​
66Defined in: [packages/query-db-collection/src/query.ts:87](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L87)
67​
68Whether the query should automatically run (default: true)
69​
70***
71​
72### meta?
73​
74```ts
75optional meta: Record<string, unknown>;
76```
77​
78Defined in: [packages/query-db-collection/src/query.ts:144](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L144)
79​
80Metadata to pass to the query.
81Available in queryFn via context.meta
82​
83#### Example
84​
85```ts
86// Using meta for error context
87queryFn: async (context) => {
88 try {
89 return await api.getTodos(userId)
90 } catch (error) {
91 // Use meta for better error messages
92 throw new Error(
93 context.meta?.errorMessage || 'Failed to load todos'
94 )
95 }
96},
97meta: {
98 errorMessage: `Failed to load todos for user ${userId}`
100```
101​
102***
103​
104### persistedGcTime?
105​
106```ts
107optional persistedGcTime: number;
108```
109​
110Defined in: [packages/query-db-collection/src/query.ts:122](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L122)
111​
112***
113​
114### queryClient
115​
116```ts
117queryClient: QueryClient;
118```
119​
120Defined in: [packages/query-db-collection/src/query.ts:83](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L83)
121​
122The TanStack Query client instance
123​
124***
125​
126### queryFn
127​
128```ts
129queryFn: TQueryFn extends (context) => any[] | Promise<any[]> ? (context) => T[] | Promise<T[]> : TQueryFn;
130```
131​
132Defined in: [packages/query-db-collection/src/query.ts:75](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L75)
133​
134Function that fetches data from the server. Must return the complete collection state
135​
136***
137​
138### queryKey
139​
140```ts
141queryKey: TQueryKey | TQueryKeyBuilder<TQueryKey>;
142```
143​
144Defined in: [packages/query-db-collection/src/query.ts:73](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L73)
145​
146The query key used by TanStack Query to identify this query
147​
148***
149​
150### refetchInterval?
151​
152```ts
153optional refetchInterval: number | false | (query) => number | false | undefined;
154```
155​
156Defined in: [packages/query-db-collection/src/query.ts:94](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L94)
157​
158***
159​
160### retry?
161​
162```ts
163optional retry: RetryValue<TError>;
164```
165​
166Defined in: [packages/query-db-collection/src/query.ts:101](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L101)
167​
168***
169​
170### retryDelay?
171​
172```ts
173optional retryDelay: RetryDelayValue<TError>;
174```
175​
176Defined in: [packages/query-db-collection/src/query.ts:108](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L108)
177​
178***
179​
180### select()?
181​
182```ts
183optional select: (data) => T[];
184```
185​
186Defined in: [packages/query-db-collection/src/query.ts:81](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L81)
187​
188#### Parameters
189​
190##### data
191​
192`TQueryData`
193​
194#### Returns
195​
196`T`[]
197​
198***
199​
200### staleTime?
201​
202```ts
203optional staleTime: StaleTimeFunction<TQueryData, TError, TQueryData, TQueryKey>;
204```
205​
206Defined in: [packages/query-db-collection/src/query.ts:115](https://github.com/TanStack/db/blob/main/packages/query-db-collection/src/query.ts#L115)