API Docs for:
Show:

BaseDict Class

Extends Collection
Defined in: /home/ubuntu/base-domain/src/lib/base-dict.coffee:5
Module: base-domain

dictionary-structured data model

Methods

$append

(
  • item
)
BaseDict public

Defined in /home/ubuntu/base-domain/src/lib/base-dict.coffee:221

replace or add item and return a new dict

Parameters:

Returns:

BaseDict:

newDict

$include

(
  • [options]
)
Promise(BaseModel)

Inherited from BaseModel: /home/ubuntu/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

$remove

(
  • item
)
BaseDict public

Defined in /home/ubuntu/base-domain/src/lib/base-dict.coffee:179

remove submodel and create a new dict both acceptable, keys and submodels

Parameters:

Returns:

BaseDict:

newDict

$replace

(
  • item
)
BaseDict public

Defined in /home/ubuntu/base-domain/src/lib/base-dict.coffee:205

replace item and return a new dict

Parameters:

Returns:

BaseDict:

newDict

$set

() BaseModel

Inherited from BaseModel: /home/ubuntu/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/src/lib/base-model.coffee:228

unset property and create a new model

Parameters:

  • prop String

    property name

Returns:

BaseModel:

this

add

(
  • ...items
)
public

Inherited from Collection but overwritten in /home/ubuntu/base-domain/src/lib/collection.coffee:117

add new submodel to item(s)

Parameters:

addItem

(
  • item
)
protected

Inherited from Collection but overwritten in /home/ubuntu/base-domain/src/lib/base-dict.coffee:137

add item to @items

Parameters:

addItems

(
  • items
)
protected

Inherited from Collection: /home/ubuntu/base-domain/src/lib/collection.coffee:141

Parameters:

  • items Object | Array(BaseModel | Object)

clear

()

Inherited from Collection but overwritten in /home/ubuntu/base-domain/src/lib/collection.coffee:200

removes all items and ids

clone

() BaseModel

Inherited from BaseModel but overwritten in /home/ubuntu/base-domain/src/lib/collection.coffee:403

clone the model as a plain object

Returns:

BaseModel:

contains

(
  • item
)
Boolean public

Defined in /home/ubuntu/base-domain/src/lib/base-dict.coffee:63

check if the model contains the given submodel or not

Parameters:

Returns:

Boolean:

copyWith

() BaseModel

Inherited from BaseModel: /home/ubuntu/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/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/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/src/lib/base-model.coffee:90

Returns:

Object(key: String => Number):

equals

(
  • vo
)
Boolean

Inherited from BaseModel but overwritten in /home/ubuntu/base-domain/src/lib/value-object.coffee:18

check equality

Parameters:

Returns:

Boolean:

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:

every

(
  • fn
  • _this
)
Boolean public

Inherited from Collection: /home/ubuntu/base-domain/src/lib/collection.coffee:288

Returns if every items match the condition in given function

Parameters:

  • fn Function
  • _this Object

Returns:

Boolean:

filter

(
  • fn
  • _this
)
Array public

Inherited from Collection: /home/ubuntu/base-domain/src/lib/collection.coffee:258

Filter items with given function

Parameters:

  • fn Function
  • _this Object

Returns:

Array:

forEach

(
  • fn
  • _this
)
public

Inherited from Collection: /home/ubuntu/base-domain/src/lib/collection.coffee:230

Execute given function for each item

Parameters:

  • fn Function
  • _this Object

get

(
  • key
)
BaseModel public

Defined in /home/ubuntu/base-domain/src/lib/base-dict.coffee:112

return submodel of the given key

Parameters:

  • key String | Number

Returns:

BaseModel:

getDiff

(
  • plainObj
  • [options]
)
Object public

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

Deprecated: just use this.facade

Get facade

Returns:

Facade:

getItem

(
  • key
)
BaseModel public

Defined in /home/ubuntu/base-domain/src/lib/base-dict.coffee:124

return submodel of the given key throw error when not found.

Parameters:

  • key String | Number

Returns:

BaseModel:

getItemModelClass

() Function

Inherited from Collection: /home/ubuntu/base-domain/src/lib/collection.coffee:431

get item model

Returns:

Function:

getModelProps

() ModelProps private

Inherited from BaseModel: /home/ubuntu/base-domain/src/lib/base-model.coffee:109

Returns:

ModelProps:

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:

has

(
  • key
)
Boolean public

Defined in /home/ubuntu/base-domain/src/lib/base-dict.coffee:51

check if the model has submodel of the given key or not

Parameters:

  • key String | Number

Returns:

Boolean:

include

(
  • [options]
)
Promise(BaseModel)

Inherited from BaseModel but overwritten in /home/ubuntu/base-domain/src/lib/collection.coffee:307

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/src/lib/base-model.coffee:518

Check if all subentities are included.

Returns:

Boolean:

inherit

(
  • anotherModel
)
BaseModel

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

inherit value of anotherModel

Parameters:

Returns:

BaseModel:

this

initItems

() protected

Defined in /home/ubuntu/base-domain/src/lib/base-dict.coffee:43

key

() protected static

Defined in /home/ubuntu/base-domain/src/lib/base-dict.coffee:14

get unique key from item

keys

() Array public

Defined in /home/ubuntu/base-domain/src/lib/base-dict.coffee:248

get all keys

Returns:

Array:

keyValues

(
  • fn
)
public

Defined in /home/ubuntu/base-domain/src/lib/base-dict.coffee:260

iterate key - item

Parameters:

  • fn Function

    1st argument: key, 2nd argument: value

loaded

() Boolean public

Inherited from Collection: /home/ubuntu/base-domain/src/lib/collection.coffee:423

Returns:

Boolean:

map

(
  • fn
  • _this
)
Array public

Inherited from Collection: /home/ubuntu/base-domain/src/lib/collection.coffee:242

Execute given function for each item returns an array of the result

Parameters:

  • fn Function
  • _this Object

Returns:

Array:

plainClone

() Object public

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

clone the model as a plain object

Returns:

Object:

remove

(
  • item
)
public

Defined in /home/ubuntu/base-domain/src/lib/base-dict.coffee:150

remove submodel from items both acceptable, keys and submodels

Parameters:

setEnum

(
  • prop
  • value
)
private

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

set enum value

Parameters:

  • prop String
  • value String | Number

setIds

(
  • ids
)
chainable

Inherited from Collection: /home/ubuntu/base-domain/src/lib/collection.coffee:170

clear and set ids.

Parameters:

  • ids Array(String | Number)

setItems

(
  • items
)

Inherited from Collection: /home/ubuntu/base-domain/src/lib/collection.coffee:186

clear and add items

Parameters:

  • items Object | Array(BaseModel | Object)

setRoot

() protected

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

some

(
  • fn
  • _this
)
Boolean public

Inherited from Collection: /home/ubuntu/base-domain/src/lib/collection.coffee:273

Returns if some items match the condition in given function

Parameters:

  • fn Function
  • _this Object

Returns:

Boolean:

toArray

() public

Inherited from Collection but overwritten in /home/ubuntu/base-domain/src/lib/base-dict.coffee:237

export models to Array

toggle

(
  • item
)

Defined in /home/ubuntu/base-domain/src/lib/base-dict.coffee:78

turn on/off the value

Parameters:

toggle

(
  • item
)
BaseDict

Defined in /home/ubuntu/base-domain/src/lib/base-dict.coffee:95

turn on/off the value and create a new model

Parameters:

Returns:

BaseDict:

newDict

toObject

() public

Defined in /home/ubuntu/base-domain/src/lib/base-dict.coffee:274

to key-value object

toPlainArray

() Array

Inherited from Collection: /home/ubuntu/base-domain/src/lib/collection.coffee:381

create plain array.

Returns:

Array:

plainArray

toPlainObject

() Object

Inherited from BaseModel but overwritten in /home/ubuntu/base-domain/src/lib/collection.coffee:352

create plain object. if this dict contains entities, returns their ids if this dict contains non-entity models, returns their plain objects

Returns:

Object:

plainObject

unset

(
  • prop
)
BaseModel

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

unset property

Parameters:

  • prop String

    property name

Returns:

BaseModel:

this

Properties

itemFactory

FactoryInterface

Inherited from Collection: /home/ubuntu/base-domain/src/lib/collection.coffee:68

item factory Created only one time. Be careful that @root is not changed even the collection's root is changed.

itemLength

Number public

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

the number of items

items

Object

Inherited from Collection but overwritten in /home/ubuntu/base-domain/src/lib/base-dict.coffee:36

items: dictionary of keys - models

length

Number public

Inherited from Collection: /home/ubuntu/base-domain/src/lib/collection.coffee:28

the number of items (or ids when @isItemEntity is true)