API Docs for:
Show:

BaseDict Class

Extends BaseModel
Defined in: src/lib/base-dict.coffee:4
Module: base-domain

dictionary-structured data model

Methods

contains

(
  • item
)
Boolean public

Defined in src/lib/base-dict.coffee:116

check if the model contains the given submodel or not

Parameters:

Returns:

Boolean:

containsEntity

() Boolean public static

Defined in src/lib/base-dict.coffee:223

returns item is Entity

Returns:

Boolean:

emitLoaded

() private

Defined in src/lib/base-dict.coffee:290

tell listeners emit loaded

get

(
  • key
)
BaseModel public

Defined in src/lib/base-dict.coffee:130

return submodel of the given key

Parameters:

  • key String | Number

Returns:

BaseModel:

get

(
  • item
)
public

Defined in src/lib/base-dict.coffee:142

add new submodel to item(s)

Parameters:

getAnonymousClass

(
  • itemModelName
)
Function

Defined in src/lib/base-dict.coffee:33

creates child class of BaseDict

Parameters:

  • itemModelName String

Returns:

Function:

child class of BaseDict

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:

has

(
  • key
)
Boolean public

Defined in src/lib/base-dict.coffee:105

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: 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

key

() protected static

Defined in src/lib/base-dict.coffee:23

get unique key from item

on

() public

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

on addEventlisteners for 'loaded'

remove

(
  • item
)
public

Defined in src/lib/base-dict.coffee:156

remove submodel from items both acceptable, keys and submodels

Parameters:

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

setIds

(
  • ids
)

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

set ids.

Parameters:

  • ids Array(String | Number)

setItems

(
  • models
)

Defined in src/lib/base-dict.coffee:206

set items from dic object update to new key

Parameters:

  • models Object | Array

toArray

() public

Defined in src/lib/base-dict.coffee:235

export models to Array

toPlainObject

() Object

Inherited from BaseModel but overwritten in src/lib/base-dict.coffee:245

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

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

ids

Array public

Defined in src/lib/base-dict.coffee:49

ids: get ids of items

itemFactory

BaseFactory

Defined in src/lib/base-dict.coffee:75

itemFactory: instance of factory which creates item models

itemModelName

String protected static

Defined in src/lib/base-dict.coffee:13

model name of the item

items

Objects

Defined in src/lib/base-dict.coffee:61

items: dictionary of keys - models

loaded

Boolean

Defined in src/lib/base-dict.coffee:68

loaded: is data loaded or not