Skip to main content

System

Extends

Constructors

Constructor

new System(options?): System;

Parameters

ParameterType
optionsSystemOptions

Returns

System

Overrides

BaseObserver<SystemListener>.constructor

Properties

PropertyModifierType
definitionspublicMap<string, EntityDefinition<any>>
loggerreadonlyLogger
storespublicSet<AbstractStore<AbstractStoreListener>>

Accessors

ideName

Methods

addStore()

addStore<T>(symbol, store): void;

Type Parameters

Type Parameter
T extends AbstractStore<AbstractStoreListener>

Parameters

ParameterType
symbolNewable<T>
storeT

Returns

void


decodeEntity()

decodeEntity<T>(entity): Promise<T>;

Type Parameters

Type Parameter
T

Parameters

ParameterType
entityEncodedEntity

Returns

Promise<T>


encodeEntity()

encodeEntity(entity, throws?): EncodedEntity<{
}>;

Parameters

ParameterTypeDefault value
entityanyundefined
throwsbooleantrue

Returns

EncodedEntity<{ }>


getDefinition()

getDefinition<T>(type): EntityDefinition<T>;

Type Parameters

Type Parameter
T

Parameters

ParameterType
typestring

Returns

EntityDefinition<T>


getDefinitionForEntity()

getDefinitionForEntity<T>(entity): EntityDefinition<T>;

Type Parameters

Type Parameter
T

Parameters

ParameterType
entityany

Returns

EntityDefinition<T>


getEntityDefinitions()

getEntityDefinitions(): EntityDefinition<any>[];

Returns

EntityDefinition<any>[]


getStores()

getStores(): AbstractStore<AbstractStoreListener>[];

Returns

AbstractStore<AbstractStoreListener>[]


initStores()

initStores(): Promise<void>;

Returns

Promise<void>


registerAction()

registerAction(action): void;

Parameters

ParameterTypeDescription
actionAction-

Returns

void

Deprecated

use actionStore directly


registerDefinition()

registerDefinition(definition): void;

Parameters

ParameterType
definitionEntityDefinition

Returns

void


unbindStore()

unbindStore<T>(symbol): void;

Type Parameters

Type Parameter
T extends AbstractStore<AbstractStoreListener>

Parameters

ParameterType
symbolNewable<T>

Returns

void