Skip to content

AnyField

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

Any field type (unspecified/mixed)

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

optional constraints: AnyConstraints

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

Validation constraints applied to values

BaseField.constraints


optional description: string

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

Human-readable description

ArrayField.description


optional example: any

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

Example value for this field

ArrayField.example


optional examples: any[]

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

Examples for this field

ArrayField.examples


optional format: string

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

Field format — optional addition to the type

ArrayField.format


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

BaseField.missingValues


name: string

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

Name of the field matching the column name

ArrayField.name


optional rdfType: string

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

URI for semantic type (RDF)

ArrayField.rdfType


optional title: string

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

Human-readable title

ArrayField.title


optional type: "any"

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

Field type - discriminator property