Class SchemaField

constructor

• new SchemaField(data?): SchemaField

• Parameters

  • Optional data: Partial<schema.SchemaField>

  Returns SchemaField

colDefinition

• colDefinition(): string

• ColDefinition returns the field db column type definition as string.

  Returns string

initOptions

• initOptions(): void

• InitOptions initializes the current field options based on its type.

  Returns error on unknown field type.

  Returns void

marshalJSON

• marshalJSON(): string | number[]

• MarshalJSON implements the [json.Marshaler] interface.

  Returns string | number[]

prepareValue

• prepareValue(value): any

• PrepareValue returns normalized and properly formatted field value.

  Parameters

  • value: any

  Returns any

prepareValueWithModifier

• prepareValueWithModifier(baseValue, modifier, modifierValue): any

• PrepareValueWithModifier returns normalized and properly formatted field value by "merging" baseValue with the modifierValue based on the specified modifier (+ or -).

  Parameters

  • baseValue: any

  • modifier: string

  • modifierValue: any

  Returns any

string

• string(): string

• String serializes and returns the current field as string.

  Returns string

unmarshalJSON

• unmarshalJSON(data): void

• UnmarshalJSON implements the [json.Unmarshaler] interface.

  The schema field options are auto initialized on success.

  Parameters

  • data: string | number[]

  Returns void

validate

• validate(): void

• Validate makes SchemaField validatable by implementing [validation.Validatable] interface.

  Returns void

id

name

options

presentable

required

system

type

unique