BaseField
Defined in: packages/core/src/fields/baseTypes.ts:562
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.
BaseFieldInput for the user-facing input type
Extended by
Section titled “Extended by”TextFieldEmailFieldTextareaFieldJsonFieldNumberFieldCheckboxFieldBlocksFieldSelectFieldRelationshipFieldDateFieldUrlFieldColorFieldArrayFieldGroupFieldUploadFieldRichTextField
Type Parameters
Section titled “Type Parameters”TCollectionSlug
Section titled “TCollectionSlug”TCollectionSlug extends VexResourceSlug = VexResourceSlug
TFieldMeta
Section titled “TFieldMeta”TFieldMeta extends object = { }
Properties
Section titled “Properties”admin:
FieldAdminConfig<TCollectionSlug>
Defined in: packages/core/src/fields/baseTypes.ts:576
Resolved admin UI configuration with all defaults applied.
defaultValue?
Section titled “defaultValue?”
optionaldefaultValue?:unknown
Defined in: packages/core/src/fields/baseTypes.ts:574
Pre-filled value shown in the admin form when creating a new field. Does not apply to database values
description?
Section titled “description?”
optionaldescription?:string
Defined in: packages/core/src/fields/baseTypes.ts:585
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?
Section titled “index?”
optionalindex?:ResolvedFieldIndexConfigInput
Defined in: packages/core/src/fields/baseTypes.ts:589
Convex index name for this field, or the object form for a compound index.
interfaceDescription?
Section titled “interfaceDescription?”
optionalinterfaceDescription?:string
Defined in: packages/core/src/fields/baseTypes.ts:587
The JSDoc comment on the generated document interface property
interfaceType
Section titled “interfaceType”interfaceType:
string
Defined in: packages/core/src/fields/baseTypes.ts:591
TypeScript type string written to generated document interfaces (e.g. "string", "number", "string[]").
label:
string
Defined in: packages/core/src/fields/baseTypes.ts:567
Display label shown in the admin form. Always set — inferred from the field key if not provided.
meta:
TFieldMeta
Defined in: packages/core/src/fields/baseTypes.ts:592
required
Section titled “required”required:
boolean
Defined in: packages/core/src/fields/baseTypes.ts:569
Whether this field is required in the database schema.
Methods
Section titled “Methods”validate()?
Section titled “validate()?”
optionalvalidate(props):void|Promise<void>
Defined in: packages/core/src/fields/baseTypes.ts:597
Server-only async validation, run after the generated Zod schema passes.
Parameters
Section titled “Parameters”FieldValidateProps<TCollectionSlug>
Returns
Section titled “Returns”void | Promise<void>