API Docs for:
Show:

Entity Class

Extends BaseModel
Defined in: src/lib/entity.coffee:5
Module: base-domain

Base model class with "id" column

Methods

getFacade

() Facade

Inherited from Base: src/lib/base.coffee:32

get facade

the implementation is in Facade#requre()

Returns:

Facade:

getPropInfo

() PropInfo public

Inherited from BaseModel: src/lib/base-model.coffee:58

get an instance of PropInfo, which summarizes properties of this class

Returns:

PropInfo:

include

(
  • [options]
)
Promise(BaseModel)

Inherited from BaseModel: src/lib/base-model.coffee:258

include all relational models if not set

Parameters:

  • [options] Object optional
    • [recursive] Boolean optional

      recursively include models or not

Returns:

Promise(BaseModel):

self

inherit

(
  • anotherModel
)
BaseModel

Inherited from BaseModel: src/lib/base-model.coffee:205

inherit value of anotherModel

Parameters:

Returns:

BaseModel:

this

setEntityProp

(
  • prop
  • submodel
)
BaseModel

Inherited from BaseModel: src/lib/base-model.coffee:167

set related model(s)

Parameters:

  • prop String

    property name of the related model

  • submodel Entity | Array

Returns:

BaseModel:

this

toPlainObject

() Object

Inherited from BaseModel: src/lib/base-model.coffee:220

create plain object without relational entities descendants of Entity are removed, but not descendants of BaseModel descendants of Entity in descendants of BaseModel are removed ( = recursive)

Returns:

Object:

plainObject

unsetEntityProp

(
  • prop
)
BaseModel

Inherited from BaseModel: src/lib/base-model.coffee:189

unset related model(s)

Parameters:

  • prop String

    property name of the related models

Returns:

BaseModel:

this

Properties

id

Any

Defined in src/lib/entity.coffee:16

primary key for the model