API Docs for:
Show:

BaseList Class

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

list class of DDD pattern.

Methods

containsEntity

() Boolean public static

Defined in src/lib/base-list.coffee:141

returns item is Entity

Returns:

Boolean:

emitLoaded

() private

Defined in src/lib/base-list.coffee:244

tell listeners emit loaded

first

() public

Defined in src/lib/base-list.coffee:163

first item

getAnonymousClass

(
  • itemModelName
)
Function

Defined in src/lib/base-list.coffee:24

creates child class of BaseList

Parameters:

  • itemModelName String

Returns:

Function:

child class of BaseList

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

last

() public

Defined in src/lib/base-list.coffee:176

last item

on

() public

Defined in src/lib/base-list.coffee:228

on addEventListeners for 'loaded'

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-list.coffee:97

set ids.

Parameters:

  • ids Array(String | Number)

setItems

(
  • models
)

Defined in src/lib/base-list.coffee:124

set items

Parameters:

  • models Array

sort

() protected

Defined in src/lib/base-list.coffee:153

sort items in constructor

toArray

() public

Defined in src/lib/base-list.coffee:189

export models to Array

toPlainObject

() Object

Inherited from BaseModel but overwritten in src/lib/base-list.coffee:199

create plain list. if this list contains entities, returns their ids if this list 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-list.coffee:41

ids: get ids of items

itemFactory

BaseFactory

Defined in src/lib/base-list.coffee:67

itemFactory: instance of factory which creates item models

itemModelName

String protected static

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

model name of the item

items

Array

Defined in src/lib/base-list.coffee:53

items: array of models

loaded

Boolean

Defined in src/lib/base-list.coffee:60

loaded: is data loaded or not