Skip to content

API Reference

Quick reference tables for all Property System types.

Property Types

ClassType TDefaultBuilder Method
StringPropertyString''string()
IntPropertyint0integer()
DoublePropertydouble0.0decimal()
BoolPropertyboolfalseboolean()
DateTimePropertyDateTimeDateTime.now()dateTime()
OptionalStringPropertyString?nulloptionalText()
OptionalIntPropertyint?nulloptionalInteger()
OptionalDoublePropertydouble?nulloptionalDecimal()
OptionalBoolPropertybool?nulloptionalBoolean()
OptionalDateTimePropertyDateTime?nulloptionalDateTime()
EnumProperty<T>TFirst optionenumeration<T>()
ListProperty<T>List<T>[]list<T>()
UnionPropertyStringSelected key(constructor)
ReadOnlyProperty<T>TRequiredreadonly<T>()

Conditions

ClassDependenciesBuilder Shorthand
EqualsCondition<T>[key]when<T>(key, value)
NotEqualsCondition<T>[key]whenNot<T>(key, value)
InCondition<T>[key]whenIn<T>(key, values)
NotInCondition<T>[key]whenNotIn<T>(key, values)
HasValueCondition[key]whenHasValue(key)
ComparisonCondition<T>[key]whenGreaterThan<T>() / whenLessThan<T>()
AndConditionUnionwhenAll(conditions)
OrConditionUnionwhenAny(conditions)
NotConditionChild(constructor)
AlwaysTrueCondition[](constructor)
AlwaysFalseCondition[](constructor)
CustomConditionExplicitwhenCustom(deps, fn)

Validators

Factory MethodType TError Key
required()dynamicrequired
min(value)nummin
max(value)nummax
minLength(length)StringminLength
maxLength(length)StringmaxLength
pattern(regex)Stringpattern
identifier()Stringpattern
email()Stringemail
custom(fn)TUser-defined

JSON Converters

ConverterTypeJSON Format
StringJsonConverterString"text"
IntJsonConverterint42
DoubleJsonConverterdouble3.14
BoolJsonConverterbooltrue / false
DateTimeJsonConverterDateTimeISO 8601 string
NullableJsonConverter<T>T?Wraps inner converter
EnumJsonConverter<T>T extends Enum"enumName"
EnumOptionsJsonConverter<T>T"valueName"
ListJsonConverter<T>List<T>[...]
UnionJsonConverterString"key"

Collection & Builder

ClassPurpose
PropertyCollectionContainer for properties with validation, conditions, serialization
PropertyGroupNamed group for visual organization
PropertyCollectionBuilderFluent builder for constructing collections
PropertyCollectionEditorWidget for rendering editable property forms
PropertyDerivationAuto-computed property value definition

Registry

MethodDescription
PropertySystem.register<T>(editor:, converter:, key:)Register editor and/or converter
PropertySystem.getEditor<T>(customKey)Look up editor
PropertySystem.getConverter<T>(customKey)Look up converter
PropertySystem.isRegistered<T>(customKey)Check both editor and converter
PropertySystem.hasEditor<T>(customKey)Check editor only
PropertySystem.hasConverter<T>(customKey)Check converter only
PropertySystem.validate()Return warnings for incomplete registrations
PropertySystem.clear()Clear all registrations

Detailed Reference Pages