GlobalConfig
Defined in: packages/core/src/globals/types.ts:157
Resolved global config returned by defineGlobal() and stored in
VexConfig.globals.
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).
TFieldSlug
Section titled “TFieldSlug”TFieldSlug extends string = string
Union of field key string literals.
TComponent
Section titled “TComponent”TComponent extends ComponentHKT = ComponentHKT
Component HKT binding.
Properties
Section titled “Properties”admin:
GlobalAdminConfig<TComponent>
Defined in: packages/core/src/globals/types.ts:171
Resolved admin config.
fields
Section titled “fields”fields:
Record<TFieldSlug,AdminField<TFieldMeta>>
Defined in: packages/core/src/globals/types.ts:169
Resolved field definitions.
interfaceName
Section titled “interfaceName”interfaceName:
string
Defined in: packages/core/src/globals/types.ts:176
PascalCase interface name for generated TypeScript types.
E.g. "siteSettings" → "SiteSettingsGlobal".
label:
string
Defined in: packages/core/src/globals/types.ts:167
Human-readable label.
meta:
TGlobalMeta
Defined in: packages/core/src/globals/types.ts:178
Global-level metadata.
slug:
TGlobalSlug
Defined in: packages/core/src/globals/types.ts:165
Unique slug — the lookup key in vex_globals.
versions
Section titled “versions”versions:
object
Defined in: packages/core/src/globals/types.ts:180
Resolved versioning config. Always present after defaults.
drafts
Section titled “drafts”drafts:
boolean