queryCollectionOptions

Function: queryCollectionOptions()

ts
function queryCollectionOptions<TItem, TError, TQueryKey, TKey, TInsertInput>(config): CollectionConfig<TItem, string | number, StandardSchemaV1<unknown, unknown>, TItem> & object
function queryCollectionOptions<TItem, TError, TQueryKey, TKey, TInsertInput>(config): CollectionConfig<TItem, string | number, StandardSchemaV1<unknown, unknown>, TItem> & object

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

Creates query collection options for use with a standard Collection

Type Parameters

TItem extends object

TError = unknown

TQueryKey extends readonly unknown[] = readonly unknown[]

TKey extends string | number = string | number

TInsertInput extends object = TItem

Parameters

config

QueryCollectionConfig<TItem, TError, TQueryKey>

Configuration options for the Query collection

Returns

CollectionConfig<TItem, string | number, StandardSchemaV1<unknown, unknown>, TItem> & object

Collection options with utilities