API Docs for:
Show:

Entity Class

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

Base model class with "id" column

Methods

$include

(
  • [options]
)
Promise(BaseModel)

Inherited from BaseModel: /home/ubuntu/base-domain-loopback/node_modules/base-domain/src/lib/base-model.coffee:502

include all relational models and returns new model

Parameters:

  • [options] Object optional
    • [async=true] Boolean optional

      get async values

    • [props] Array(String) optional

      include only given props

Returns:

Promise(BaseModel):

new model

$set

() BaseModel

Inherited from BaseModel: /home/ubuntu/base-domain-loopback/node_modules/base-domain/src/lib/base-model.coffee:167

set value to prop and create a new model

Returns:

BaseModel:

this

$unset

(
  • prop
)
BaseModel

Inherited from BaseModel: /home/ubuntu/base-domain-loopback/node_modules/base-domain/src/lib/base-model.coffee:228

unset property and create a new model

Parameters:

  • prop String

    property name

Returns:

BaseModel:

this

copyWith

() BaseModel

Inherited from BaseModel: /home/ubuntu/base-domain-loopback/node_modules/base-domain/src/lib/base-model.coffee:340

shallow copy the model with props

Returns:

BaseModel:

deprecated

(
  • methodName
  • message
)
Error protected

Inherited from Base: /home/ubuntu/base-domain-loopback/node_modules/base-domain/src/lib/base.coffee:158

Show indication message of deprecated method

Parameters:

  • methodName String
  • message String

Returns:

Error:

diff

(
  • plainObj
  • [options]
)
Array(String) public

Inherited from BaseModel but overwritten in /home/ubuntu/base-domain-loopback/node_modules/base-domain/src/lib/base-model.coffee:390

Get diff props

Parameters:

  • plainObj Any
  • [options] Object optional
    • [ignores] Array(String) optional

      prop names to skip checking diff

Returns:

Array(String):

enum

() Object(key: String => Number) public

Inherited from BaseModel but overwritten in /home/ubuntu/base-domain-loopback/node_modules/base-domain/src/lib/base-model.coffee:90

Returns:

Object(key: String => Number):

equals

(
  • entity
)
Boolean

Inherited from BaseModel but overwritten in /home/ubuntu/base-domain-loopback/node_modules/base-domain/src/lib/entity.coffee:27

check equality

Parameters:

Returns:

Boolean:

error

(
  • reason
  • [message]
)
Error

Inherited from Base: /home/ubuntu/base-domain-loopback/node_modules/base-domain/src/lib/base.coffee:145

create instance of DomainError

Parameters:

  • reason String

    reason of the error

  • [message] String optional

Returns:

Error:

getDiff

(
  • plainObj
  • [options]
)
Object public

Inherited from BaseModel: /home/ubuntu/base-domain-loopback/node_modules/base-domain/src/lib/base-model.coffee:373

Get diff prop values

Parameters:

  • plainObj Any
  • [options] Object optional
    • [ignores] Array(String) optional

      prop names to skip checking diff

Returns:

Object:

getFacade

() Facade deprecated

Inherited from Base: /home/ubuntu/base-domain-loopback/node_modules/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-loopback/node_modules/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-loopback/node_modules/base-domain/src/lib/base.coffee:106

get parent class

Returns:

Function:

include

(
  • [options]
)
Promise(BaseModel)

Inherited from BaseModel: /home/ubuntu/base-domain-loopback/node_modules/base-domain/src/lib/base-model.coffee:486

include all relational models if not set

Parameters:

  • [options] Object optional
    • [async=true] Boolean optional

      get async values

    • [props] Array(String) optional

      include only given props

Returns:

Promise(BaseModel):

self

included

() Boolean

Inherited from BaseModel: /home/ubuntu/base-domain-loopback/node_modules/base-domain/src/lib/base-model.coffee:518

Check if all subentities are included.

Returns:

Boolean:

inherit

(
  • anotherModel
)
BaseModel

Inherited from BaseModel: /home/ubuntu/base-domain-loopback/node_modules/base-domain/src/lib/base-model.coffee:248

inherit value of anotherModel

Parameters:

Returns:

BaseModel:

this

plainClone

() Object public

Inherited from BaseModel: /home/ubuntu/base-domain-loopback/node_modules/base-domain/src/lib/base-model.coffee:301

clone the model as a plain object

Returns:

Object:

setEnum

(
  • prop
  • value
)
private

Inherited from BaseModel: /home/ubuntu/base-domain-loopback/node_modules/base-domain/src/lib/base-model.coffee:181

set enum value

Parameters:

  • prop String
  • value String | Number

toPlainObject

() Object

Inherited from BaseModel: /home/ubuntu/base-domain-loopback/node_modules/base-domain/src/lib/base-model.coffee:262

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

unset

(
  • prop
)
BaseModel

Inherited from BaseModel: /home/ubuntu/base-domain-loopback/node_modules/base-domain/src/lib/base-model.coffee:208

unset property

Parameters:

  • prop String

    property name

Returns:

BaseModel:

this