Class Field

Model field class.

Hierarchy

Field

Index

Constructors

constructor

Properties

_cfg

Methods

Constructors

constructor

new Field(config: FieldConfig): Field

Parameters
- config: FieldConfig
Returns Field

Properties

Protected _cfg

_cfg: FieldConfig

Methods

alias

alias(): string

Returns string

config

config(): FieldConfig
config(cfg: FieldConfig): this

Returns FieldConfig
Parameters
- cfg: FieldConfig
Returns this

defaultValue

defaultValue(): any

Returns any

isId

isId(): boolean

Returns boolean

name

name(): string

Returns string

nullable

nullable(): boolean

Returns boolean

set

set(val: any): any

Parameters
- val: any
Returns any

validate

validate(value: any, errors?: ValidateResult): boolean | string

Validates the passed value for this field.

Parameters
- value: any
  
  The value to validate.
- Optional errors: ValidateResult
Returns boolean | string

if the value is valid. A string may be returned if the value is not valid, to indicate an error message. Any other non true value indicates the value is not valid. This method is not implemented by default, subclasses may override it to provide an implementation.