ListField

Defined in: core/field/types/List.ts:6

List field type (primitive values ordered collection)

Extends

• BaseField<ListConstraints>

Indexable

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

Properties

constraints?

optional constraints: ListConstraints

Defined in: core/field/types/Base.ts:42

Validation constraints applied to values

Inherited from

BaseField.constraints

---

delimiter?

optional delimiter: string

Defined in: core/field/types/List.ts:15

Character used to separate values in the list

---

description?

optional description: string

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

Human-readable description

Inherited from

BaseField.description

---

example?

optional example: any

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

Example value for this field

Inherited from

BaseField.example

---

itemType?

optional itemType: "string" | "number" | "boolean" | "integer" | "datetime" | "date" | "time"

Defined in: core/field/types/List.ts:20

Type of items in the list

---

missingValues?

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

Defined in: core/field/types/Base.ts:37

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: core/field/types/Base.ts:10

Name of the field matching the column name

Inherited from

BaseField.name

---

rdfType?

optional rdfType: string

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

URI for semantic type (RDF)

Inherited from

BaseField.rdfType

---

title?

optional title: string

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

Human-readable title

Inherited from

BaseField.title

---

type

type: "list"

Defined in: core/field/types/List.ts:10

Field type - discriminator property