API Docs for:
Show:

BaseFactory Class

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

Base factory class of DDD pattern.

create instance of model

Methods

createDict

(
  • dictModelName
  • obj
  • [options={}]
)
BaseDict public

Defined in /home/ubuntu/base-domain/src/lib/base-factory.coffee:93

create model dict

Parameters:

  • dictModelName String

    model name of dict

  • obj Any
  • [options={}] Object optional
    • [include] Object optional

      options to pass to Includer

      • [async=false] Object optional
        include submodels asynchronously
      • [props] Array(String) optional
        include submodels of given props

Returns:

BaseDict:

dict

createEmpty

() BaseModel

Defined in /home/ubuntu/base-domain/src/lib/base-factory.coffee:51

create empty model instance

Returns:

BaseModel:

createFromObject

(
  • obj
  • [options={}]
)
BaseModel public

Defined in /home/ubuntu/base-domain/src/lib/base-factory.coffee:60

create instance of model class by plain object

for each prop, values are set by Model#set(prop, value)

Parameters:

  • obj Object
  • [options={}] Object optional
    • [include] Object optional

      options to pass to Includer

      • [async=false] Object optional
        include submodels asynchronously
      • [props] Array(String) optional
        include submodels of given props

Returns:

BaseModel:

model

createList

(
  • listModelName
  • obj
  • [options={}]
)
BaseList public

Defined in /home/ubuntu/base-domain/src/lib/base-factory.coffee:77

create model list

Parameters:

  • listModelName String

    model name of list

  • obj Any
  • [options={}] Object optional
    • [include] Object optional

      options to pass to Includer

      • [async=false] Object optional
        include submodels asynchronously
      • [props] Array(String) optional
        include submodels of given props

Returns:

BaseList:

list

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:

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:

getFacade

() Facade deprecated

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

Deprecated: just use this.facade

Get facade

Returns:

Facade:

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:

setRoot

() protected

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

Properties

modelName

String protected static

Defined in /home/ubuntu/base-domain/src/lib/base-factory.coffee:18

model name to handle