Defined in: packages/query-db-collection/src/query.ts:54
Configuration options for creating a Query Collection
T extends object = object
The explicit type of items stored in the collection
TQueryFn extends (context) => Promise<any> = (context) => Promise<any>
The queryFn type
TError = unknown
The type of errors that can occur during queries
TQueryKey extends QueryKey = QueryKey
The type of the query key
TKey extends string | number = string | number
The type of the item keys
TSchema extends StandardSchemaV1 = never
The schema type for validation
TQueryData = Awaited<ReturnType<TQueryFn>>
optional enabled: boolean;
optional enabled: boolean;
Defined in: packages/query-db-collection/src/query.ts:80
Whether the query should automatically run (default: true)
optional meta: Record<string, unknown>;
optional meta: Record<string, unknown>;
Defined in: packages/query-db-collection/src/query.ts:130
Metadata to pass to the query. Available in queryFn via context.meta
// Using meta for error context
queryFn: async (context) => {
try {
return await api.getTodos(userId)
} catch (error) {
// Use meta for better error messages
throw new Error(
context.meta?.errorMessage || 'Failed to load todos'
)
}
},
meta: {
errorMessage: `Failed to load todos for user ${userId}`
}
// Using meta for error context
queryFn: async (context) => {
try {
return await api.getTodos(userId)
} catch (error) {
// Use meta for better error messages
throw new Error(
context.meta?.errorMessage || 'Failed to load todos'
)
}
},
meta: {
errorMessage: `Failed to load todos for user ${userId}`
}
queryClient: QueryClient;
queryClient: QueryClient;
Defined in: packages/query-db-collection/src/query.ts:76
The TanStack Query client instance
queryFn: TQueryFn extends (context) => Promise<any[]> ? (context) => Promise<T[]> : TQueryFn;
queryFn: TQueryFn extends (context) => Promise<any[]> ? (context) => Promise<T[]> : TQueryFn;
Defined in: packages/query-db-collection/src/query.ts:68
Function that fetches data from the server. Must return the complete collection state
queryKey: TQueryKey;
queryKey: TQueryKey;
Defined in: packages/query-db-collection/src/query.ts:66
The query key used by TanStack Query to identify this query
optional refetchInterval: number | false | (query) => number | false | undefined;
optional refetchInterval: number | false | (query) => number | false | undefined;
Defined in: packages/query-db-collection/src/query.ts:81
optional retry: RetryValue<TError>;
optional retry: RetryValue<TError>;
Defined in: packages/query-db-collection/src/query.ts:88
optional retryDelay: RetryDelayValue<TError>;
optional retryDelay: RetryDelayValue<TError>;
Defined in: packages/query-db-collection/src/query.ts:95
optional select: (data) => T[];
optional select: (data) => T[];
Defined in: packages/query-db-collection/src/query.ts:74
TQueryData
T[]
optional staleTime: StaleTimeFunction<T[], TError, T[], TQueryKey>;
optional staleTime: StaleTimeFunction<T[], TError, T[], TQueryKey>;
Defined in: packages/query-db-collection/src/query.ts:102