Function: collectionOptions()#

Call Signature#

function collectionOptions<T, TKey, TUtils>(options): CollectionOptions<InferSchemaOutput<T>, TKey, T, TUtils> & NonSingleResult;

Defined in: packages/db/src/client.ts:179

Type Parameters#

T#

T extends StandardSchemaV1<unknown, unknown>

TKey#

TKey extends string | number

TUtils#

TUtils extends UtilsRecord

Parameters#

options#

CollectionConfig<InferSchemaOutput<T>, TKey, T, TUtils> & object & NonSingleResult

Returns#

CollectionOptions<InferSchemaOutput<T>, TKey, T, TUtils> & NonSingleResult

Call Signature#

function collectionOptions<T, TKey, TUtils>(options): CollectionOptions<InferSchemaOutput<T>, TKey, T, TUtils> & SingleResult;

Defined in: packages/db/src/client.ts:188

Type Parameters#

T#

T extends StandardSchemaV1<unknown, unknown>

TKey#

TKey extends string | number

TUtils#

TUtils extends UtilsRecord

Parameters#

options#

CollectionConfig<InferSchemaOutput<T>, TKey, T, TUtils> & object & SingleResult

Returns#

CollectionOptions<InferSchemaOutput<T>, TKey, T, TUtils> & SingleResult

Call Signature#

function collectionOptions<T, TKey, TUtils>(options): CollectionOptions<T, TKey, never, TUtils> & NonSingleResult;

Defined in: packages/db/src/client.ts:197

Type Parameters#

T#

T extends object

TKey#

TKey extends string | number = string | number

TUtils#

TUtils extends UtilsRecord = UtilsRecord

Parameters#

options#

CollectionConfig<T, TKey, never, TUtils> & object & NonSingleResult

Returns#

CollectionOptions<T, TKey, never, TUtils> & NonSingleResult

Call Signature#

function collectionOptions<T, TKey, TUtils>(options): CollectionOptions<T, TKey, never, TUtils> & SingleResult;

Defined in: packages/db/src/client.ts:206

Type Parameters#

T#

T extends object

TKey#

TKey extends string | number = string | number

TUtils#

TUtils extends UtilsRecord = UtilsRecord

Parameters#

options#

CollectionConfig<T, TKey, never, TUtils> & object & SingleResult

Returns#

CollectionOptions<T, TKey, never, TUtils> & SingleResult

Call Signature#

function collectionOptions<TConfig>(id, factory): DescriptorFromConfig<TConfig>;

Defined in: packages/db/src/client.ts:215

Type Parameters#

TConfig#

TConfig extends AnyCollectionConfig

Parameters#

id#

string

factory#

(client) => TConfig

Returns#

DescriptorFromConfig<TConfig>