CollectionConfigInput

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

Configuration input for a defineCollection() call.

A collection maps to a Convex database table. slug becomes the table name, fields defines its shape, and labels controls how the collection appears in the admin panel. Omitted labels are inferred from the slug.

Defaults applied by defineCollection():

{
  labels: {
    singular: "Post",   // title-cased from slug ("posts" → "Post")
    plural:   "Posts",  // title-cased + pluralised from slug
  }
}

Example

defineCollection({
  slug: "posts",
  fields: {
    title: text({ required: true }),
    body:  richtext(),
  },
})

See

• CollectionConfig for the resolved type after defaults are applied
• defineCollection for the config function

Type Parameters

TFieldMeta

TFieldMeta extends object = { }

TCollectionMeta

TCollectionMeta extends object = { }

TCollectionSlug

TCollectionSlug extends string = string

TFieldSlug

TFieldSlug extends string = string

TComponent

TComponent extends ComponentHKT = ComponentHKT

Properties

admin?

optional admin?: AdminCollectionConfigInput<TFieldSlug, TComponent>

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

Admin panel behaviour for this collection. All properties are optional.

---

fields

fields: Record<TFieldSlug, AdminField<TFieldMeta>>

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

Field definitions that make up this collection’s document shape.

---

indexes?

optional indexes?: object[]

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

Index definitions that create indexes on this collection in Convex.

fields

fields: NoInfer<TFieldSlug>[]

name

name: string

---

interfaceName?

optional interfaceName?: string

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

Override the PascalCase interface name used in generated TypeScript types. Inferred from slug by defineCollection if omitted.

---

labels?

optional labels?: object

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

Display names shown in the admin panel navigation and list views. Both are inferred from slug if omitted.

plural?

optional plural?: string

Plural display name (e.g. "Posts"). Inferred from slug if omitted.

singular?

optional singular?: string

Singular display name (e.g. "Post"). Inferred from slug if omitted.

---

meta?

optional meta?: TCollectionMeta

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

---

slug

slug: TCollectionSlug

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

Convex table name — used as the database table identifier and URL slug in the admin panel.