@vttforge/core / DataFieldOptions

Interface: DataFieldOptions

Properties shared by every Foundry data field option object.

Mirrors the base DataFieldOptions interface documented at https://foundryvtt.com/api/classes/foundry.data.fields.DataField.html.

Extended by

• ArrayFieldOptions
• ForeignDocumentFieldOptions
• NumberFieldOptions
• StringFieldOptions

Properties

gmOnly?

readonly optional gmOnly?: boolean

---

hint?

readonly optional hint?: string

---

initial?

readonly optional initial?: unknown

---

label?

readonly optional label?: string

---

nullable?

readonly optional nullable?: boolean

---

readonly?

readonly optional readonly?: boolean

---

required?

readonly optional required?: boolean

---

validate?

readonly optional validate?: (value) => boolean | undefined

Parameters

value

unknown

Returns

boolean | undefined

---

validationError?

readonly optional validationError?: string