Options
All
  • Public
  • Public/Protected
  • All
Menu

Describe all field's options

Hierarchy

  • IFieldOptions

Index

Properties

Optional default

default: any

Indicates the initial field's value

Optional factory

Indicate the field's constructor class of target

Optional fixed

fixed: undefined | number

The scale for a decimal (exact numeric) field (applies only for decimal field), which represents the number of digits to the right of the decimal point

Optional isRequired

isRequired: undefined | false | true

Indicates if field's value can not be set to null or undefined when marshall JSON

Optional isVirtual

isVirtual: undefined | false | true

Indicates if field's value is ignored when marshall JSON

Optional length

length: undefined | number

Field type's length.

Optional name

name: undefined | string

Field name in JSON

Optional readOnly

readOnly: undefined | false | true

Indicates if field's value is read only

Optional transformer

transformer: ITransformer

Specifies a value transformer that is to be used to (un)marshal this field when (un)marshal.

Optional type

type: FieldType

Field type. Must be one of the values from the FieldType

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc