GlobalConfig
Defined in: packages/core/src/globals/types.ts:222
Resolved global config returned by defineGlobal() and stored in
VexConfig.globals.
Type Param
Section titled “Type Param”TFieldSlug
Union of field key string literals.
Type Parameters
Section titled “Type Parameters”TFieldMeta
Section titled “TFieldMeta”TFieldMeta extends object = { }
Field-level metadata.
TGlobalMeta
Section titled “TGlobalMeta”TGlobalMeta extends object = { }
Global-level metadata.
TGlobalSlug
Section titled “TGlobalSlug”TGlobalSlug extends GlobalSlug = GlobalSlug
The exact slug type (narrowed from GlobalSlug).
TFields
Section titled “TFields”TFields extends Record<string, AdminField<TFieldMeta>> = Record<string, AdminField<TFieldMeta>>
TComponent
Section titled “TComponent”TComponent extends ComponentHKT = ComponentHKT
Component HKT binding.
TDrafts
Section titled “TDrafts”TDrafts extends boolean = boolean
Properties
Section titled “Properties”admin:
GlobalAdminConfig<TComponent,TGlobalSlug>
Defined in: packages/core/src/globals/types.ts:239
Resolved admin config.
fields
Section titled “fields”fields:
TFields
Defined in: packages/core/src/globals/types.ts:235
Resolved field definitions.
hooks:
GlobalHooks<TGlobalSlug>
Defined in: packages/core/src/globals/types.ts:237
Resolved lifecycle hooks. Always present; defaults to {}.
interfaceName
Section titled “interfaceName”interfaceName:
string
Defined in: packages/core/src/globals/types.ts:244
PascalCase interface name for generated TypeScript types.
E.g. "siteSettings" → "SiteSettingsGlobal".
label:
string
Defined in: packages/core/src/globals/types.ts:233
Human-readable label.
meta:
TGlobalMeta
Defined in: packages/core/src/globals/types.ts:246
Global-level metadata.
slug:
TGlobalSlug
Defined in: packages/core/src/globals/types.ts:231
Unique slug — the lookup key in vex_globals.
versions
Section titled “versions”versions:
object
Defined in: packages/core/src/globals/types.ts:248
Resolved versioning config. Always present after defaults.
autosave
Section titled “autosave”autosave:
object
autosave.debounceMs
Section titled “autosave.debounceMs”debounceMs:
number
autosave.enabled
Section titled “autosave.enabled”enabled:
boolean
drafts
Section titled “drafts”drafts:
TDrafts