Defined in: packages/query-db-collection/src/query.ts:61

Configuration options for creating a Query Collection

• BaseCollectionConfig<T, TKey, TSchema>

T extends object = object

The explicit type of items stored in the collection

TQueryFn extends (context) => any = (context) => 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: Enabled<TQueryData, TError, TQueryData, TQueryKey>;

Defined in: packages/query-db-collection/src/query.ts:87

Whether the query should automatically run (default: true)

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

// 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}`
}

optional persistedGcTime: number;

Defined in: packages/query-db-collection/src/query.ts:122

queryClient: QueryClient;

Defined in: packages/query-db-collection/src/query.ts:83

The TanStack Query client instance

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: TQueryKey | TQueryKeyBuilder<TQueryKey>;

Defined in: packages/query-db-collection/src/query.ts:73

The query key used by TanStack Query to identify this query

optional refetchInterval: number | false | (query) => number | false | undefined;

Defined in: packages/query-db-collection/src/query.ts:94

optional retry: RetryValue<TError>;

Defined in: packages/query-db-collection/src/query.ts:101

optional retryDelay: RetryDelayValue<TError>;

Defined in: packages/query-db-collection/src/query.ts:108

optional select: (data) => T[];

Defined in: packages/query-db-collection/src/query.ts:81

TQueryData

T[]

optional staleTime: StaleTimeFunction<TQueryData, TError, TQueryData, TQueryKey>;

Defined in: packages/query-db-collection/src/query.ts:115