Interface: QueryCollectionConfig<T, TQueryFn, TError, TQueryKey, TKey, TSchema, TQueryData>#
Defined in: packages/query-db-collection/src/query.ts:61
Configuration options for creating a Query Collection
Extends#
BaseCollectionConfig<T,TKey,TSchema>
Type Parameters#
T#
T extends object = object
The explicit type of items stored in the collection
TQueryFn#
TQueryFn extends (context) => any = (context) => any
The queryFn type
TError#
TError = unknown
The type of errors that can occur during queries
TQueryKey#
TQueryKey extends QueryKey = QueryKey
The type of the query key
TKey#
TKey extends string | number = string | number
The type of the item keys
TSchema#
TSchema extends StandardSchemaV1 = never
The schema type for validation
TQueryData#
TQueryData = Awaited<ReturnType<TQueryFn>>
Properties#
enabled?#
optional enabled: Enabled<TQueryData, TError, TQueryData, TQueryKey>;
Defined in: packages/query-db-collection/src/query.ts:87
Whether the query should automatically run (default: true)
meta?#
optional meta: Record<string, unknown>;
Defined in: packages/query-db-collection/src/query.ts:144
Metadata to pass to the query. Available in queryFn via context.meta
Example#
// 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}`
}
persistedGcTime?#
optional persistedGcTime: number;
Defined in: packages/query-db-collection/src/query.ts:122
queryClient#
queryClient: QueryClient;
Defined in: packages/query-db-collection/src/query.ts:83
The TanStack Query client instance
queryFn#
queryFn: TQueryFn extends (context) => any[] | Promise<any[]> ? (context) => T[] | Promise<T[]> : TQueryFn;
Defined in: packages/query-db-collection/src/query.ts:75
Function that fetches data from the server. Must return the complete collection state
queryKey#
queryKey: TQueryKey | TQueryKeyBuilder<TQueryKey>;
Defined in: packages/query-db-collection/src/query.ts:73
The query key used by TanStack Query to identify this query
refetchInterval?#
optional refetchInterval: number | false | (query) => number | false | undefined;
Defined in: packages/query-db-collection/src/query.ts:94
retry?#
optional retry: RetryValue<TError>;
Defined in: packages/query-db-collection/src/query.ts:101
retryDelay?#
optional retryDelay: RetryDelayValue<TError>;
Defined in: packages/query-db-collection/src/query.ts:108
select()?#
optional select: (data) => T[];
Defined in: packages/query-db-collection/src/query.ts:81
Parameters#
data#
TQueryData
Returns#
T[]
staleTime?#
optional staleTime: StaleTimeFunction<TQueryData, TError, TQueryData, TQueryKey>;
Defined in: packages/query-db-collection/src/query.ts:115