API Docs for:
Show:

AggregateRoot Class

Extends Entity
Defined in: /home/ubuntu/base-domain/src/lib/aggregate-root.coffee:6
Module: base-domain

Methods

$include

(
  • [options]
)
Promise(BaseModel)

Inherited from BaseModel: /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

Inherited from BaseModel: /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

Inherited from BaseModel: /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

Inherited from BaseModel: /home/ubuntu/base-domain/src/lib/base-model.coffee:325

create clone

Returns:

BaseModel:

copyWith

() BaseModel

Inherited from BaseModel: /home/ubuntu/base-domain/src/lib/base-model.coffee:340

shallow copy the model with props

Returns:

BaseModel:

createFactory

(
  • modFirstName
)
BaseFactory

Defined in /home/ubuntu/base-domain/src/lib/aggregate-root.coffee:35

create a factory instance 2nd, 3rd, 4th ... arguments are the params to pass to the constructor of the factory

Parameters:

  • modFirstName String

Returns:

BaseFactory:

createModel

(
  • modFirstName
  • obj
  • [options]
)
BaseModel

Defined in /home/ubuntu/base-domain/src/lib/aggregate-root.coffee:61

create an instance of the given modFirstName using obj if obj is null or undefined, empty object will be created.

Parameters:

  • modFirstName String
  • obj Object
  • [options] Object optional

Returns:

BaseModel:

createPreferredFactory

(
  • firstName
  • [options]
)
BaseFactory

Defined in /home/ubuntu/base-domain/src/lib/aggregate-root.coffee:104

create a preferred factory instance 3rd, 4th ... arguments are the params to pass to the constructor of the factory

Parameters:

  • firstName String
  • [options] Object optional
    • [noParent=true] Object optional

      if true, stop requiring parent class

Returns:

BaseFactory:

createPreferredRepository

(
  • firstName
  • [options]
)
BaseRepository

Defined in /home/ubuntu/base-domain/src/lib/aggregate-root.coffee:89

create a preferred repository instance 3rd, 4th ... arguments are the params to pass to the constructor of the repository

Parameters:

  • firstName String
  • [options] Object optional
    • [noParent] Object optional

      if true, stop requiring parent class

Returns:

BaseRepository:

createPreferredService

(
  • firstName
  • [options]
)
BaseService

Defined in /home/ubuntu/base-domain/src/lib/aggregate-root.coffee:121

create a preferred service instance 3rd, 4th ... arguments are the params to pass to the constructor of the factory

Parameters:

  • firstName String
  • [options] Object optional
    • [noParent=true] Object optional

      if true, stop requiring parent class

Returns:

BaseService:

createRepository

(
  • modFirstName
)
BaseRepository

Defined in /home/ubuntu/base-domain/src/lib/aggregate-root.coffee:48

create a repository instance 2nd, 3rd, 4th ... arguments are the params to pass to the constructor of the repository

Parameters:

  • modFirstName String

Returns:

BaseRepository:

createService

(
  • modFirstName
)
BaseRepository

Defined in /home/ubuntu/base-domain/src/lib/aggregate-root.coffee:76

create a service instance 2nd, 3rd, 4th ... arguments are the params to pass to the constructor of the service

Parameters:

  • modFirstName String

Returns:

BaseRepository:

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
  • [options]
)
Array(String) public

Inherited from BaseModel but overwritten 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(key: String => Number) public

Inherited from BaseModel but overwritten in /home/ubuntu/base-domain/src/lib/base-model.coffee:90

Returns:

Object(key: String => Number):

equals

(
  • entity
)
Boolean

Inherited from BaseModel but overwritten in /home/ubuntu/base-domain/src/lib/entity.coffee:27

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

Inherited from BaseModel: /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

Inherited from BaseModel: /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)

Inherited from BaseModel: /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

Inherited from BaseModel: /home/ubuntu/base-domain/src/lib/base-model.coffee:518

Check if all subentities are included.

Returns:

Boolean:

inherit

(
  • anotherModel
)
BaseModel

Inherited from BaseModel: /home/ubuntu/base-domain/src/lib/base-model.coffee:248

inherit value of anotherModel

Parameters:

Returns:

BaseModel:

this

plainClone

() Object public

Inherited from BaseModel: /home/ubuntu/base-domain/src/lib/base-model.coffee:301

clone the model as a plain object

Returns:

Object:

set

()

Defined in /home/ubuntu/base-domain/src/lib/aggregate-root.coffee:170

set value to prop set memories

setEnum

(
  • prop
  • value
)
private

Inherited from BaseModel: /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

Inherited from BaseModel but overwritten in /home/ubuntu/base-domain/src/lib/aggregate-root.coffee:151

create plain object without relational entities plainize memoryResources

Returns:

Object:

plainObject

unset

(
  • prop
)
BaseModel

Inherited from BaseModel: /home/ubuntu/base-domain/src/lib/base-model.coffee:208

unset property

Parameters:

  • prop String

    property name

Returns:

BaseModel:

this

useMemoryResource

(
  • modelName
)
MemoryResource

Defined in /home/ubuntu/base-domain/src/lib/aggregate-root.coffee:138

get or create a memory resource to save to @memories Only called from LocalRepository

Parameters:

  • modelName String

Returns:

MemoryResource:

Properties

id

String | Number

Inherited from Entity: /home/ubuntu/base-domain/src/lib/entity.coffee:14

primary key for the model

isRoot

Boolean static

Defined in /home/ubuntu/base-domain/src/lib/aggregate-root.coffee:15

is root (to identify RootInterface)

memories

Object(MemoryResource)

Defined in /home/ubuntu/base-domain/src/lib/aggregate-root.coffee:22

key: modelName, value: MemoryResource