Skip to main content
Version: 0.3.0

PropertyDefinition

age-schema-client v0.3.0


age-schema-client / PropertyDefinition

Interface: PropertyDefinition

Defined in: src/schema/types.ts:276

Property definition

Properties

PropertyTypeDescriptionDefined in
type| PropertyType | PropertyType[]Property data typesrc/schema/types.ts:280
description?stringProperty descriptionsrc/schema/types.ts:285
default?unknownDefault valuesrc/schema/types.ts:290
required?booleanWhether the property is requiredsrc/schema/types.ts:295
nullable?booleanWhether the property can be nullsrc/schema/types.ts:300
stringConstraints?StringConstraintsString constraints (for string properties)src/schema/types.ts:305
numberConstraints?NumberConstraintsNumber constraints (for number properties)src/schema/types.ts:310
arrayConstraints?ArrayConstraintsArray constraints (for array properties)src/schema/types.ts:315
objectConstraints?ObjectConstraintsObject constraints (for object properties)src/schema/types.ts:320
customValidator?stringCustom validation function namesrc/schema/types.ts:325
metadata?Record<string, unknown>Additional metadatasrc/schema/types.ts:330