ObjectField

Defined in: field/types/Object.ts:6

Object field type (serialized JSON object)

Extends

• BaseField<ObjectConstraints>

Indexable

[key: `${string}:${string}`]: any

Properties

constraints?

optional constraints: ObjectConstraints

Defined in: field/types/Base.ts:52

Validation constraints applied to values

Inherited from

BaseField.constraints

---

description?

optional description: string

Defined in: field/types/Base.ts:25

Human-readable description

Inherited from

BaseField.description

---

example?

optional example: any

Defined in: field/types/Base.ts:30

Example value for this field

Inherited from

BaseField.example

---

examples?

optional examples: any[]

Defined in: field/types/Base.ts:35

Examples for this field

Inherited from

BaseField.examples

---

format?

optional format: string

Defined in: field/types/Base.ts:15

Field format — optional addition to the type

Inherited from

BaseField.format

---

missingValues?

optional missingValues: (string | { label: string; value: string; })[]

Defined in: field/types/Base.ts:47

Values representing missing data for this field Can be a simple array of strings or an array of {value, label} objects where label provides context for why the data is missing

Inherited from

BaseField.missingValues

---

name

name: string

Defined in: field/types/Base.ts:10

Name of the field matching the column name

Inherited from

BaseField.name

---

rdfType?

optional rdfType: string

Defined in: field/types/Base.ts:40

URI for semantic type (RDF)

Inherited from

BaseField.rdfType

---

title?

optional title: string

Defined in: field/types/Base.ts:20

Human-readable title

Inherited from

BaseField.title

---

type

type: "object"

Defined in: field/types/Object.ts:10

Field type - discriminator property