CommitTsField

Defined in: packages/core/src/fields/commitTs/types.ts:98

Resolved configuration for a commitTs() field, after all defaults are applied.

See

• CommitTsFieldInput for the user-facing input type
• commitTs for the config function that produces this type

Extends

• Omit<BaseField<TCollectionSlug, TFieldMeta>, "required" | "defaultValue" | "admin">

Type Parameters

TCollectionSlug

TCollectionSlug extends VexResourceSlug = VexResourceSlug

TFieldMeta

TFieldMeta extends object = { }

Properties

admin

admin: FieldAdminConfig<TCollectionSlug, ComponentHKT> & object

Defined in: packages/core/src/fields/commitTs/types.ts:118

Resolved admin config — the full FieldAdminConfig shape every data field carries, plus format.

Type Declaration

format

format: CommitTsFieldAdminFormat

---

defaultValue

defaultValue: number | undefined

Defined in: packages/core/src/fields/commitTs/types.ts:115

undefined on a brand-new, not-yet-saved document (no stamp has happened yet) — never an admin-settable default. Once stamped, holds the resolved Unix-ms value (find/get/search convert Convex’s bigint ns before this is ever read); typed number | undefined rather than the input type’s bare undefined so every generic consumer keyed off TField["defaultValue"] (CellComponentProps, ColumnDef’s value type, …) sees the field’s real stored-value type.

---

description?

optional description?: string

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

Semantic description of the field. Used in three places:

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

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

Inherited from

BaseField.description

---

index?

optional index?: ResolvedFieldIndexConfigInput

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

Convex index name for this field, or the object form for a compound index.

Inherited from

BaseField.index

---

interfaceDescription?

optional interfaceDescription?: string

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

The JSDoc comment on the generated document interface property

Inherited from

BaseField.interfaceDescription

---

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[]").

Inherited from

BaseField.interfaceType

---

label

label: string

Defined in: packages/core/src/fields/commitTs/types.ts:103

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

Overrides

BaseField.label

---

meta

meta: TFieldMeta

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

Inherited from

Omit.meta

---

on

on: CommitTsFieldOn

Defined in: packages/core/src/fields/commitTs/types.ts:116

---

required

required: false

Defined in: packages/core/src/fields/commitTs/types.ts:105

Always false — a commitTs field is never required input; it is never input at all.

---

type

readonly type: "commitTs"

Defined in: packages/core/src/fields/commitTs/types.ts:102

---

validate?

optional validate?: (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

props

FieldValidateProps<TCollectionSlug>

Returns

void | Promise<void>

See

FieldValidate

Inherited from

Omit.validate