API Docs for:
Show:

ModelProps Class

Defined in: /home/ubuntu/base-domain/src/lib/model-props.coffee:4
Module: base-domain

parses model properties and classifies them

Methods

getAllProps

() Array(String) public

Defined in /home/ubuntu/base-domain/src/lib/model-props.coffee:129

get all prop names

Returns:

Array(String):

getDefaultValue

(
  • prop
)
Any public

Defined in /home/ubuntu/base-domain/src/lib/model-props.coffee:308

get the default value of the prop

Parameters:

  • prop String

Returns:

Any:

defaultValue

getEntityPropByIdProp

(
  • idPropName
)
String public

Defined in /home/ubuntu/base-domain/src/lib/model-props.coffee:245

get entity prop of the given idPropName

Parameters:

  • idPropName String

Returns:

String:

submodelProp

getEntityProps

() Array(String) public

Defined in /home/ubuntu/base-domain/src/lib/model-props.coffee:140

get all entity prop names

Returns:

Array(String):

getIdPropByEntityProp

(
  • prop
)
String public

Defined in /home/ubuntu/base-domain/src/lib/model-props.coffee:269

get prop name of id of entity prop

Parameters:

  • prop String

Returns:

String:

idPropName

getSubModelProps

(
  • prop
)
String public

Defined in /home/ubuntu/base-domain/src/lib/model-props.coffee:282

get model name of model prop

Parameters:

  • prop String

Returns:

String:

model name

getSubModelProps

() Array(String) public

Defined in /home/ubuntu/base-domain/src/lib/model-props.coffee:151

get all model prop names

Returns:

Array(String):

isDate

(
  • prop
)
Boolean public

Defined in /home/ubuntu/base-domain/src/lib/model-props.coffee:198

check if the given prop is date

Parameters:

  • prop String

Returns:

Boolean:

isEntity

(
  • prop
)
Boolean public

Defined in /home/ubuntu/base-domain/src/lib/model-props.coffee:163

check if the given prop is entity prop

Parameters:

  • prop String

Returns:

Boolean:

isEnum

(
  • prop
)
Boolean public

Defined in /home/ubuntu/base-domain/src/lib/model-props.coffee:210

check if the given prop is enum

Parameters:

  • prop String

Returns:

Boolean:

isEnumDic

(
  • prop
)
Object public

Defined in /home/ubuntu/base-domain/src/lib/model-props.coffee:222

get value - enum pair

Parameters:

  • prop String

Returns:

Object:

isEnumValues

(
  • prop
)
Array(String) public

Defined in /home/ubuntu/base-domain/src/lib/model-props.coffee:233

get values of enum

Parameters:

  • prop String

Returns:

Array(String):

isId

(
  • prop
)
Boolean public

Defined in /home/ubuntu/base-domain/src/lib/model-props.coffee:187

check if the given prop is submodel's id

Parameters:

  • prop String

Returns:

Boolean:

isModel

(
  • prop
)
Boolean public

Defined in /home/ubuntu/base-domain/src/lib/model-props.coffee:175

check if the given prop is model prop

Parameters:

  • prop String

Returns:

Boolean:

isOmitted

(
  • prop
)
Boolean public

Defined in /home/ubuntu/base-domain/src/lib/model-props.coffee:257

check if the given prop is tmp prop

Parameters:

  • prop String

Returns:

Boolean:

isOptional

(
  • prop
)
Boolean public

Defined in /home/ubuntu/base-domain/src/lib/model-props.coffee:295

check if the prop is optional

Parameters:

  • prop String

Returns:

Boolean:

parse

() private

Defined in /home/ubuntu/base-domain/src/lib/model-props.coffee:53

parse props by type

parseProp

() private

Defined in /home/ubuntu/base-domain/src/lib/model-props.coffee:67

parse one prop by type

parseSubModelProp

() private

Defined in /home/ubuntu/base-domain/src/lib/model-props.coffee:96

parse submodel prop

Properties

createdAt

String public

Defined in /home/ubuntu/base-domain/src/lib/model-props.coffee:19

property whose type is CREATED_AT

dates

Array(String) public

Defined in /home/ubuntu/base-domain/src/lib/model-props.coffee:45

properties whose type is DATE, CREATED_AT and UPDATED_AT

updatedAt

String public

Defined in /home/ubuntu/base-domain/src/lib/model-props.coffee:27

property whose type is UPDATED_AT