CollectionConfig

Defined in: packages/core/src/collections/types.ts:288

Resolved collection configuration after defaults are applied by defineCollection().

See

• CollectionConfigInput for the user-facing input type
• defineCollection for the config function

Type Parameters

TFieldMeta

TFieldMeta extends object = { }

TCollectionMeta

TCollectionMeta extends object = { }

TCollectionSlug

TCollectionSlug extends CollectionSlug = CollectionSlug

TFieldSlug

TFieldSlug extends string = string

TComponent

TComponent extends ComponentHKT = ComponentHKT

Properties

admin

admin: AdminCollectionConfig<TFieldSlug, TComponent>

Defined in: packages/core/src/collections/types.ts:296

Resolved admin panel configuration for this collection.

---

fields

fields: Record<TFieldSlug, AdminField<TFieldMeta>>

Defined in: packages/core/src/collections/types.ts:307

Resolved field definitions for this collection.

---

indexes?

optional indexes?: object[]

Defined in: packages/core/src/collections/types.ts:311

Index definitions that create indexes on this collection in Convex.

fields

fields: NoInfer<TFieldSlug>[]

name

name: string

---

interfaceName

interfaceName: string

Defined in: packages/core/src/collections/types.ts:309

PascalCase identifier derived from slug, used as the TypeScript interface name in generated types (e.g. "posts" → "Posts").

---

labels

labels: object

Defined in: packages/core/src/collections/types.ts:300

Display names shown in the admin panel — always present after defaults are applied.

plural

plural: string

Plural display name (e.g. "Posts").

singular

singular: string

Singular display name (e.g. "Post").

---

meta

meta: TCollectionMeta

Defined in: packages/core/src/collections/types.ts:315

---

slug

slug: TCollectionSlug

Defined in: packages/core/src/collections/types.ts:298

Convex table name for this collection.