API Docs for:
Show:

BaseModel Class

Extends Base
Defined in: /home/ubuntu/base-domain/src/lib/base-model.coffee:8
Module: base-domain

Base model class of DDD pattern.

Methods

$include

(
  • [options]
)
Promise(BaseModel)

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

include all relational models and returns new model

Parameters:

  • [options] Object optional
    • [async=true] Boolean optional

      get async values

    • [props] Array(String) optional

      include only given props

Returns:

Promise(BaseModel):

new model

$set

() BaseModel

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

set value to prop and create a new model

Returns:

BaseModel:

this

$unset

(
  • prop
)
BaseModel

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

unset property and create a new model

Parameters:

  • prop String

    property name

Returns:

BaseModel:

this

clone

() BaseModel public

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

create clone

Returns:

BaseModel:

copyWith

() BaseModel

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

shallow copy the model with props

Returns:

BaseModel:

deprecated

(
  • methodName
  • message
)
Error protected

Inherited from Base: /home/ubuntu/base-domain/src/lib/base.coffee:158

Show indication message of deprecated method

Parameters:

  • methodName String
  • message String

Returns:

Error:

diff

(
  • plainObj
)
Array(String) public

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

Get difference props

Parameters:

  • plainObj Any

Returns:

Array(String):

diff

(
  • plainObj
  • [options]
)
Array(String) public

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

Get diff props

Parameters:

  • plainObj Any
  • [options] Object optional
    • [ignores] Array(String) optional

      prop names to skip checking diff

Returns:

Array(String):

enum

() Object public

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

Returns:

Object:

enum

() Object(key: String => Number) public

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

Returns:

Object(key: String => Number):

equals

(
  • model
)
Boolean

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

check equality

Parameters:

Returns:

Boolean:

error

(
  • reason
  • [message]
)
Error

Inherited from Base: /home/ubuntu/base-domain/src/lib/base.coffee:145

create instance of DomainError

Parameters:

  • reason String

    reason of the error

  • [message] String optional

Returns:

Error:

getDiff

(
  • plainObj
  • [options]
)
Object public

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

Get diff prop values

Parameters:

  • plainObj Any
  • [options] Object optional
    • [ignores] Array(String) optional

      prop names to skip checking diff

Returns:

Object:

getFacade

() Facade deprecated

Inherited from Base: /home/ubuntu/base-domain/src/lib/base.coffee:81

Deprecated: just use this.facade

Get facade

Returns:

Facade:

getModelProps

() ModelProps private

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

Returns:

ModelProps:

getModule

() BaseModule

Inherited from Base: /home/ubuntu/base-domain/src/lib/base.coffee:96

Get module which this class belongs to

Returns:

BaseModule:

getParent

() Function

Inherited from Base: /home/ubuntu/base-domain/src/lib/base.coffee:106

get parent class

Returns:

Function:

include

(
  • [options]
)
Promise(BaseModel)

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

include all relational models if not set

Parameters:

  • [options] Object optional
    • [async=true] Boolean optional

      get async values

    • [props] Array(String) optional

      include only given props

Returns:

Promise(BaseModel):

self

included

() Boolean

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

Check if all subentities are included.

Returns:

Boolean:

inherit

(
  • anotherModel
)
BaseModel

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

inherit value of anotherModel

Parameters:

Returns:

BaseModel:

this

plainClone

() Object public

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

clone the model as a plain object

Returns:

Object:

setEnum

(
  • prop
  • value
)
private

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

set enum value

Parameters:

  • prop String
  • value String | Number

setRoot

() protected

Inherited from Base: /home/ubuntu/base-domain/src/lib/base.coffee:47

toPlainObject

() Object

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

create plain object without relational entities descendants of Entity are removed, but not descendants of BaseModel descendants of Entity in descendants of BaseModel are removed ( = recursive)

Returns:

Object:

plainObject

unset

(
  • prop
)
BaseModel

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

unset property

Parameters:

  • prop String

    property name

Returns:

BaseModel:

this

withParentProps

() Object protected static

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

extend @properties of Parent class

Returns:

Object:

Example:

class Parent extends BaseModel

Properties

isImmutable

Boolean static

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

Flag of the model's immutablity

properties

Object protected static

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

key-value pair representing property's name - type of the model

firstName    : @TYPES.STRING
lastName     : @TYPES.STRING
age          : @TYPES.NUMBER
registeredAt : @TYPES.DATE
team         : @TYPES.MODEL 'team'
hobbies      : @TYPES.MODEL 'hobby-list'
info         : @TYPES.ANY

see type-info.coffee for full options.

TYPES

Object protected final static

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

key-value pair representing typeName - type

use for definition of @properties for each extender