API Docs for:
Show:

Facade Class

Defined in: src/lib/facade.coffee:10
Module: base-domain

Facade class of DDD pattern.

  • create instance of factories
  • create instance of repositories

Methods

addClass

(
  • name
  • klass
  • skipNameValidation
)
Function private

Defined in src/lib/facade.coffee:163

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

attaches getFacade() method (for both class and instance)

Parameters:

  • name String
  • klass Function
  • skipNameValidation Boolean

    validate class name is compatible with the name to register

Returns:

Function:

create

(
  • name
  • [options]
)
BaseFactory private

Defined in src/lib/facade.coffee:201

read a file and returns the instance of the file's class

Parameters:

  • name String
  • [options] Object optional

Returns:

BaseFactory:

createFactory

(
  • name
  • [useAnonymousWhenFailed=false]
)
BaseFactory

Defined in src/lib/facade.coffee:106

create a factory instance

Parameters:

  • name String
  • [useAnonymousWhenFailed=false] Boolean optional

Returns:

BaseFactory:

createInstance

(
  • [options]
)
Facade static

Defined in src/lib/facade.coffee:22

create instance of Facade

Parameters:

  • [options] Object optional

Returns:

Facade:

createRepository

(
  • name
  • [options]
)
BaseRepository

Defined in src/lib/facade.coffee:119

create a repository instance

Parameters:

  • name String
  • [options] Object optional

Returns:

BaseRepository:

error

(
  • reason
  • [message]
)
Error

Defined in src/lib/facade.coffee:215

create instance of DomainError

Parameters:

  • reason String

    reason of the error

  • [message] String optional

Returns:

Error:

getFactory

(
  • name
  • [useAnonymousWhenFailed=false]
)
Function

Defined in src/lib/facade.coffee:74

get a factory class

ISSUE: user will never know load failure

Parameters:

  • name String
  • [useAnonymousWhenFailed=false] Boolean optional

Returns:

Function:

getModel

(
  • name
)
Class

Defined in src/lib/facade.coffee:62

get a model class

Parameters:

  • name String

Returns:

Class:

getRepository

(
  • name
)
Class

Defined in src/lib/facade.coffee:95

get a repository class

Parameters:

  • name String

Returns:

Class:

hasClass

(
  • name
)
Function

Defined in src/lib/facade.coffee:148

check existence of the class of the given name

Parameters:

  • name String

Returns:

Function:

insertFixtures

(
  • [options]
)
Promise(Object)

Defined in src/lib/facade.coffee:242

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 names to insert. default: all models

Returns:

Promise(Object):

dataPool inserted data

isBaseClass

(
  • klass
)
Boolean static

Defined in src/lib/facade.coffee:260

check the given class is registered in facade

Parameters:

  • klass Function

Returns:

Boolean:

isDomainError

(
  • e
)
Boolean

Defined in src/lib/facade.coffee:229

check if given object is instance of DomainError

Parameters:

  • e Error

Returns:

Boolean:

loadMasterTables

() Promise

Defined in src/lib/facade.coffee:52

load master tables

Returns:

Promise:

registerBaseClass

(
  • klass
)
static

Defined in src/lib/facade.coffee:273

registers the given class as a base class

Parameters:

  • klass Function

require

(
  • name
)
Function private

Defined in src/lib/facade.coffee:131

read a file and returns class

Parameters:

  • name String

Returns:

Function: