API Docs for:
Show:

BaseModule Class

Defined in: /home/ubuntu/base-domain/src/lib/base-module.coffee:5
Module: base-domain

Module of DDD pattern.

Methods

createFactory

(
  • modFirstName
)
BaseFactory

Defined in /home/ubuntu/base-domain/src/lib/base-module.coffee:84

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]
  • [root]
)
BaseModel

Defined in /home/ubuntu/base-domain/src/lib/base-module.coffee:68

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:

createPreferredFactory

(
  • modFirstName
  • [options]
)
BaseFactory

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

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

Parameters:

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

      if true, stop requiring parent class

Returns:

BaseFactory:

createPreferredRepository

(
  • modFirstName
  • [options]
)
BaseRepository

Defined in /home/ubuntu/base-domain/src/lib/base-module.coffee:123

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

Parameters:

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

      if true, stop requiring parent class

Returns:

BaseRepository:

createPreferredService

(
  • modFirstName
  • [options]
)
BaseService

Defined in /home/ubuntu/base-domain/src/lib/base-module.coffee:153

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

Parameters:

  • modFirstName 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/base-module.coffee:97

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/base-module.coffee:110

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

Parameters:

  • modFirstName String

Returns:

BaseService:

getFacade

() Facade deprecated chainable

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

Deprecated: just call facade property

Get facade

Returns:

Facade:

getModel

(
  • firstName
)
Function

Defined in /home/ubuntu/base-domain/src/lib/base-module.coffee:58

get a model class in the module

Parameters:

  • firstName String

Returns:

Function:

require

(
  • modFullName
)
Function private

Defined in /home/ubuntu/base-domain/src/lib/base-module.coffee:168

read a file and returns class

Parameters:

  • modFullName String

Returns:

Function:

Properties

isRoot

Boolean static

Defined in /home/ubuntu/base-domain/src/lib/base-module.coffee:16

is root (to identify RootInterface)