Skip to content

DateField

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

Date field type

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

optional constraints: DateConstraints

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

BaseField.description


optional example: any

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

Example value for this field

BaseField.example


optional examples: any[]

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

Examples for this field

BaseField.examples


optional format: string

Defined in: field/types/Date.ts:18

Format of the date

  • default: YYYY-MM-DD
  • any: flexible date parsing (not recommended)
  • Or custom strptime/strftime format string

BaseField.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

BaseField.name


optional rdfType: string

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

URI for semantic type (RDF)

BaseField.rdfType


optional title: string

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

Human-readable title

BaseField.title


type: "date"

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

Field type - discriminator property