BaseField

Defined in: packages/core/src/fields/baseTypes.ts:232

Resolved base field definition, after defaults are applied by the field config function.

Properties with defaults are always present. Properties that are meaningless when absent (description, index, searchIndex) remain optional.

See

BaseFieldInput for the user-facing input type

Extended by

Type Parameters

TFieldMeta

TFieldMeta extends object = { }

Properties

admin

admin: FieldAdminConfig

Defined in: packages/core/src/fields/baseTypes.ts:243

Resolved admin UI configuration with all defaults applied.

defaultValue?

optional defaultValue?: unknown

Defined in: packages/core/src/fields/baseTypes.ts:241

Pre-filled value shown in the admin form when creating a new field. Does not apply to database values

description?

optional description?: string

Defined in: packages/core/src/fields/baseTypes.ts:252

Semantic description of the field. Used in three places:

Helper text rendered below the field input in the admin form UI.
As the Zod .meta({ description }) value for form validation.
As the JSDoc comment on the generated document interface property.

To write a separate JSDoc comment, use interfaceDescription in addition.

index?

optional index?: string

Defined in: packages/core/src/fields/baseTypes.ts:256

Convex index name for this field.

interfaceDescription?

optional interfaceDescription?: string

Defined in: packages/core/src/fields/baseTypes.ts:254

The JSDoc comment on the generated document interface property

interfaceType

interfaceType: string

Defined in: packages/core/src/fields/baseTypes.ts:258

TypeScript type string written to generated document interfaces (e.g. "string", "number", "string[]").

label

label: string

Defined in: packages/core/src/fields/baseTypes.ts:234

Display label shown in the admin form. Always set — inferred from the field key if not provided.

required

required: boolean

Defined in: packages/core/src/fields/baseTypes.ts:236

Whether this field is required in the database schema.