API Docs for:
Show:

Facade Class

Defined in: /home/ubuntu/base-domain/src/lib/facade.coffee:12
Module: base-domain

Facade class of DDD pattern.

  • create instance of factories
  • create instance of repositories

Methods

addClass

(
  • modFullName
  • klass
)
Function private

Defined in /home/ubuntu/base-domain/src/lib/facade.coffee:487

add class to facade. the class is acquired by @require(modFullName)

Parameters:

  • modFullName String
  • klass Function

Returns:

Function:

create

(
  • Class
)
Base

Defined in /home/ubuntu/base-domain/src/lib/facade.coffee:154

Create instance of given Class.

Parameters:

  • Class Function | Class

Returns:

Base:

createFactory

(
  • modFirstName
)
BaseFactory

Defined in /home/ubuntu/base-domain/src/lib/facade.coffee:213

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

Parameters:

  • modFirstName String

Returns:

BaseFactory:

createInstance

(
  • [options]
)
Facade static

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

create instance of Facade

Parameters:

  • [options] Object optional

Returns:

Facade:

createModel

(
  • modFirstName
  • obj
  • [options]
  • [root]
)
BaseModel

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

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
  • [root] RootInterface optional

Returns:

BaseModel:

createPreferred

(
  • modFirstName
  • type
  • [options]
  • [params]
  • root
)
BaseFactory private

Defined in /home/ubuntu/base-domain/src/lib/facade.coffee:331

create a preferred factory|repository|service instance

Parameters:

  • modFirstName String
  • type String

    factory|repository|service

  • [options] Object optional
  • [params] Object optional

    params pass to constructor of Repository, Factory or Service

  • root RootInterface

Returns:

BaseFactory:

createPreferredFactory

(
  • firstName
  • [options]
)
BaseFactory

Defined in /home/ubuntu/base-domain/src/lib/facade.coffee:297

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/facade.coffee:282

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/facade.coffee:314

create a preferred service instance 2nd, 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/facade.coffee:225

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
)
BaseService

Defined in /home/ubuntu/base-domain/src/lib/facade.coffee:237

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

Parameters:

  • modFirstName String

Returns:

BaseService:

deserialize

(
  • str
)
Any

Defined in /home/ubuntu/base-domain/src/lib/facade.coffee:456

Deserializes serialized string

Parameters:

  • str String

Returns:

Any:

error

(
  • reason
  • [message]
)
Error

Defined in /home/ubuntu/base-domain/src/lib/facade.coffee:527

create instance of DomainError

Parameters:

  • reason String

    reason of the error

  • [message] String optional

Returns:

Error:

fullName

(
  • modFullName
)
String private

Defined in /home/ubuntu/base-domain/src/lib/facade.coffee:434

get fullName from modFullName

Parameters:

  • modFullName String

Returns:

String:

getFacade

() Facade deprecated chainable

Defined in /home/ubuntu/base-domain/src/lib/facade.coffee:32

Deprecated: just use this.facade

Get facade

Returns:

Facade:

getModel

(
  • firstName
)
Function

Defined in /home/ubuntu/base-domain/src/lib/facade.coffee:143

get a model class

Parameters:

  • firstName String

Returns:

Function:

getModelProps

(
  • modFullName
)
ModelProps

Defined in /home/ubuntu/base-domain/src/lib/facade.coffee:509

Get ModelProps by firstName. ModelProps summarizes properties of this class

Parameters:

  • modFullName String

Returns:

ModelProps:

getModule

(
  • moduleName
)
BaseModule

Defined in /home/ubuntu/base-domain/src/lib/facade.coffee:414

Parameters:

  • moduleName String

Returns:

BaseModule:

getPreferredNames

(
  • modFirstName
  • type
)
String private

Defined in /home/ubuntu/base-domain/src/lib/facade.coffee:358

Parameters:

  • modFirstName String
  • type String

    repository|factory|service

Returns:

String:

modFullName

hasClass

(
  • modFullName
)
Function

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

check existence of the class of the given name

Parameters:

  • modFullName String

Returns:

Function:

insertFixtures

(
  • [options]
)
Promise(EntityPool)

Defined in /home/ubuntu/base-domain/src/lib/facade.coffee:554

insert fixture data (Node.js only)

Parameters:

  • [options] Object optional
    • [dataDir='./data'] String optional

      directory to have fixture data files

    • [tsvDir='./tsv'] String optional

      directory to have TSV files

    • [models=null] Array(String) optional

      model firstNames to insert. default: all models

Returns:

Promise(EntityPool):

inserted data

isDomainError

(
  • e
)
Boolean

Defined in /home/ubuntu/base-domain/src/lib/facade.coffee:541

check if given object is instance of DomainError

Parameters:

  • e Error

Returns:

Boolean:

moduleName

(
  • modFullName
)
String private

Defined in /home/ubuntu/base-domain/src/lib/facade.coffee:423

get moduleName from modFullName

Parameters:

  • modFullName String

Returns:

String:

require

(
  • modFullName
)
Function private

Defined in /home/ubuntu/base-domain/src/lib/facade.coffee:379

read a file and returns class

Parameters:

  • modFullName String

Returns:

Function:

serialize

(
  • val
)
String

Defined in /home/ubuntu/base-domain/src/lib/facade.coffee:445

Serialize the given object containing model information

Parameters:

  • val Any

Returns:

String:

Properties

isRoot

Boolean static

Defined in /home/ubuntu/base-domain/src/lib/facade.coffee:24

is root (to identify RootInterface)

latestInstance

Facade static

Defined in /home/ubuntu/base-domain/src/lib/facade.coffee:43

Latest instance created via @createInstance() This instance will be attached base instances with no @root property.

master

MasterDataResource

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

instance of MasterDataResource Exist only when "master" property is given to Facade's option