API Docs for:
Show:

BaseRepository Class

Extends Base
Defined in: /home/ubuntu/base-domain/src/lib/base-repository.coffee:8
Module: base-domain

Base repository class of DDD pattern. Responsible for perpetuation of models. BaseRepository has a client, which access to data resource (RDB, NoSQL, memory, etc...)

the parent "Base" class just simply gives this.facade property

Methods

appendTimeStamp

(
  • data
  • isUpdate
)
Object protected

Defined in /home/ubuntu/base-domain/src/lib/base-repository.coffee:340

add createdAt, updatedAt to given data

  • createdAt will not be overriden if already set.
  • updatedAt will be overriden for each time

Parameters:

  • data Object
  • isUpdate Boolean

    true when updating

Returns:

Object:

data

createFromQueryResults

(
  • params
  • objs
  • [options]
)
Array(BaseModel) protected

Defined in /home/ubuntu/base-domain/src/lib/base-repository.coffee:381

Create model instances from query results

Parameters:

  • params Object
  • objs Array(Object)
  • [options] Object optional

Returns:

Array(BaseModel):

models

createFromResult

(
  • obj
  • [options]
)
BaseModel protected

Defined in /home/ubuntu/base-domain/src/lib/base-repository.coffee:368

Create model instance from result from client

Parameters:

  • obj Object
  • [options] Object optional

Returns:

BaseModel:

model

delete

(
  • entity
  • [options]
)
Boolean | Promise(Boolean) public

Defined in /home/ubuntu/base-domain/src/lib/base-repository.coffee:268

Destroy the given entity (which must have "id" value)

Parameters:

Returns:

Boolean | Promise(Boolean):

isDeleted

deprecated

(
  • methodName
  • message
)
Error protected

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

Show indication message of deprecated method

Parameters:

  • methodName String
  • message String

Returns:

Error:

error

(
  • reason
  • [message]
)
Error

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

create instance of DomainError

Parameters:

  • reason String

    reason of the error

  • [message] String optional

Returns:

Error:

get

(
  • id
  • [options]
)
Entity | Promise(Entity) public

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

get entity by id.

Parameters:

Returns:

Entity | Promise(Entity):

entity

getAll

() Array(Entity) | Promise(Array(Entity))

Defined in /home/ubuntu/base-domain/src/lib/base-repository.coffee:217

get all entities

Returns:

Array(Entity) | Promise(Array(Entity)):

array of entities

getById

(
  • id
  • [options]
)
Entity | Promise(Entity) public

Defined in /home/ubuntu/base-domain/src/lib/base-repository.coffee:181

alias for get()

Parameters:

Returns:

Entity | Promise(Entity):

entity

getByIds

(
  • ids
  • [options]
)
Array(Entity) | Promise(Array(Entity)) public

Defined in /home/ubuntu/base-domain/src/lib/base-repository.coffee:196

get entities by id.

Parameters:

Returns:

Array(Entity) | Promise(Array(Entity)):

entities

getDiff

(
  • entity
  • [options]
)
Object | Promise(Object) public

Defined in /home/ubuntu/base-domain/src/lib/base-repository.coffee:158

get diff from perpetuation layer

Parameters:

Returns:

Object | Promise(Object):

diff

getFacade

() Facade deprecated

Inherited from Base: /home/ubuntu/base-domain/src/lib/base.coffee:81

Deprecated: just use this.facade

Get facade

Returns:

Facade:

getModelClass

() Class

Defined in /home/ubuntu/base-domain/src/lib/base-repository.coffee:74

get model class this factory handles

Returns:

Class:

getModule

() BaseModule

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

get parent class

Returns:

Function:

query

(
  • [params]
  • [options]
)
Array(Entity) | Promise(Array(Entity)) public

Defined in /home/ubuntu/base-domain/src/lib/base-repository.coffee:227

Find all model instances that match params

Parameters:

  • [params] Object optional

    query parameters

  • [options] Object optional

Returns:

Array(Entity) | Promise(Array(Entity)):

array of entities

save

(
  • entity
  • [options]
)
Entity | Promise(Entity) public

Defined in /home/ubuntu/base-domain/src/lib/base-repository.coffee:99

Update or insert a model instance

Parameters:

Returns:

Entity | Promise(Entity):

entity (the same instance from input, if entity given,)

setRoot

() protected

Inherited from Base: /home/ubuntu/base-domain/src/lib/base.coffee:47

singleQuery

(
  • [params]
  • [options]
)
Entity | Promise(Entity) public

Defined in /home/ubuntu/base-domain/src/lib/base-repository.coffee:247

Find one model instance that matches params, Same as query, but limited to one result

Parameters:

  • [params] Object optional

    query parameters

  • [options] Object optional

Returns:

Entity | Promise(Entity):

entity

update

(
  • id
  • data
  • [options]
)
Entity | Promise(Entity) public

Defined in /home/ubuntu/base-domain/src/lib/base-repository.coffee:288

Update set of attributes.

Parameters:

  • id String | Number

    id of the entity to update

  • data Object

    key-value pair to update (notice: this must not be instance of Entity)

  • [options] Object optional

Returns:

Entity | Promise(Entity):

updated entity

updateProps

(
  • entity
  • data
  • [options]
)
Promise(Object) | Object public

Defined in /home/ubuntu/base-domain/src/lib/base-repository.coffee:317

Update set of attributes and returns newly-updated props (other than props)

Parameters:

  • entity Entity
  • data Object

    key-value pair to update (notice: this must not be instance of Entity)

  • [options] Object optional

Returns:

Promise(Object) | Object:

updated props

Properties

client

ResourceClientInterface protected

Defined in /home/ubuntu/base-domain/src/lib/base-repository.coffee:36

client accessing to data resource (RDB, NoSQL, memory, etc...)

mock object is input by default. Extenders must set this property to achieve perpetuation

modelName

String protected static

Defined in /home/ubuntu/base-domain/src/lib/base-repository.coffee:21

model name to handle