Class EntityBase<TProperties>`Abstract`

Default implementation of an Entity that supports observability, serialization, and async initialization.

Constructors

constructor

new EntityBase<TProperties>(properties?): EntityBase<TProperties>
Creates a new instance of the entity and assigns the given properties.
Type Parameters
- TProperties extends EntityBaseProperties = EntityBaseProperties
Parameters
- Optionalproperties: TProperties
  The properties to set via assignProperties().
Returns EntityBase<TProperties>
Overrides InitializableBase.constructor

Properties

`Protected`_id

_id: string

The unique ID for this entity. Once set, this should never change.

`Protected` `Abstract` `Readonly`_itemType

_itemType: string

The item type for this entity when it participates in an App.

Accessors

failureMode

get failureMode(): FailureMode
Determines how a parent object should handle initialization failure in this object. The default is "warn".
- "error": support/InitializeError!InitializeError is thrown.
- "warn": Message is logged and support/InitializableBase!InitializeWarningEvent is raised.
- "ignore": support/InitializableBase!InitializeWarningEvent is raised.
Returns FailureMode
Inherited from InitializableBase.failureMode
set failureMode(value): void
Parameters
- value: FailureMode
Returns void
Inherited from InitializableBase.failureMode

id

get id(): string
The unique ID for this entity.

Returns string
Implementation of Entity.id

isDestroyed

get isDestroyed(): boolean
See support/InitializableBase!Initializable.isDestroyed.

Returns boolean
Inherited from InitializableBase.isDestroyed

isInitialized

get isInitialized(): boolean
See support/InitializableBase!Initializable.isInitialized.

Returns boolean
Inherited from InitializableBase.isInitialized

itemType

get itemType(): string
The item type for this entity when it participates in an App.

Returns string
Implementation of Entity.itemType

Methods

`Protected`_getSerializableProperties

_getSerializableProperties(): PropertyDefs<TProperties>
The property keys and their metadata that are used to implement serializing and deserializing the class instance.

Returns PropertyDefs<TProperties>
Overrides InitializableBase._getSerializableProperties

`Protected`_initializableChildCollections

_initializableChildCollections(): IterableIterator<Collection<InitializableBase<InitializableBaseProperties>>, any, any>
Collections of child items to initialize. Items that fail to initialize are removed from the collection.

Returns IterableIterator<Collection<InitializableBase<InitializableBaseProperties>>, any, any>
Inherited from InitializableBase._initializableChildCollections

`Protected`_initializeChildren

_initializeChildren(): Promise<void>
Initializes child entities.

Returns Promise<void>
Inherited from InitializableBase._initializeChildren

`Protected`_onDestroy

_onDestroy(): Promise<void>
Called to perform cleanup. Subclasses should override this method rather than destroy() to perform custom cleanup.

Returns Promise<void>
Inherited from InitializableBase._onDestroy

`Protected`_onInitialize

_onInitialize(): Promise<void>
Called to perform initialization of the support/InitializableBase!InitializableBase. Subclasses should override this method rather than initialize() to perform custom initialization.

Returns Promise<void>
Inherited from InitializableBase._onInitialize

`Protected`_postInitialize

_postInitialize(): Promise<void>
Called after normal initialization. Note: Child items are initialized before this is called.

Returns Promise<void>
Inherited from InitializableBase._postInitialize

`Protected`_toPropertyDef

_toPropertyDef<T>(def): PropertyDef<T>
Converts the value to a PropertyDef object.
Type Parameters
- T
Parameters
- def: PropertyDefSerializeMode | PropertyDefSerializeMode[] | PropertyDef<T>
  The value to convert.
Returns PropertyDef<T>
Inherited from InitializableBase._toPropertyDef

assignProperties

assignProperties(properties): void
Parameters
- properties: Partial<TProperties>
Returns void
Inherit Doc
Inherited from InitializableBase.assignProperties

assignPropertiesAsync

assignPropertiesAsync(properties): Promise<void>
Parameters
- properties: Partial<TProperties>
Returns Promise<void>
Inherit Doc
Inherited from InitializableBase.assignPropertiesAsync

destroy

destroy(): Promise<void>
A clean-up function that should get called whenever the item is disposed of.

Returns Promise<void>
Inherited from InitializableBase.destroy

emit

emit(name, event): boolean
Emits an event on the instance.
Parameters
- name: string
- event: unknown
  The event payload.
  
  Read more...
Returns boolean
Inherited from InitializableBase.emit

finishAssignProperties

finishAssignProperties(): Promise<void>
Returns Promise<void>
Inherit Doc
Inherited from InitializableBase.finishAssignProperties

getDefault

getDefault<K>(key): TProperties[K]
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
Returns TProperties[K]
Inherit Doc
Inherited from InitializableBase.getDefault

getDefaults

getDefaults(): TProperties
Returns TProperties
Inherit Doc
Inherited from InitializableBase.getDefaults

getSerializableProperties

getSerializableProperties(serializeMode?): PropertyDefs<TProperties>
Returns the serializable properties.
Parameters
- OptionalserializeMode: SerializeMode
  Optional. If specified, only properties that support the given serialization mode will be returned.
Returns PropertyDefs<TProperties>
Inherited from InitializableBase.getSerializableProperties

initialize

initialize(): Promise<void>
Initializes the item.

Returns Promise<void>
Inherited from InitializableBase.initialize

on

on(name, callback): IHandle
Registers an event handler on the instance.
Parameters
- name: string | string[]
- callback: EventCallback<any>
Returns IHandle
Inherited from InitializableBase.on

toItemUri

toItemUri(): string
Creates an item:// URI reference to this entity.

Returns string
Implementation of Entity.toItemUri

toJSON

toJSON(serializeMode?): TProperties
Parameters
- serializeMode: SerializeMode = "all"
Returns TProperties
Inherit Doc
Inherited from InitializableBase.toJSON

Class EntityBase<TProperties>Abstract

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns EntityBase<TProperties>

Properties

Protected_id

Protected Abstract Readonly_itemType

Accessors

failureMode

Returns FailureMode

Parameters

Returns void

id

Returns string

isDestroyed

Returns boolean

isInitialized

Returns boolean

itemType

Returns string

Methods

Protected_getSerializableProperties

Returns PropertyDefs<TProperties>

Protected_initializableChildCollections

Returns IterableIterator<Collection<InitializableBase<InitializableBaseProperties>>, any, any>

Protected_initializeChildren

Returns Promise<void>

Protected_onDestroy

Returns Promise<void>

Protected_onInitialize

Returns Promise<void>

Protected_postInitialize

Returns Promise<void>

Protected_toPropertyDef

Type Parameters

Parameters

Returns PropertyDef<T>

assignProperties

Parameters

Returns void

Inherit Doc

assignPropertiesAsync

Parameters

Returns Promise<void>

Inherit Doc

destroy

Returns Promise<void>

emit

Parameters

Returns boolean

finishAssignProperties

Returns Promise<void>

Inherit Doc

getDefault

Type Parameters

Parameters

Returns TProperties[K]

Inherit Doc

getDefaults

Returns TProperties

Inherit Doc

getSerializableProperties

Parameters

Returns PropertyDefs<TProperties>

initialize

Returns Promise<void>

on

Parameters

Returns IHandle

toItemUri

Class EntityBase<TProperties>`Abstract`

`Protected`_id

`Protected` `Abstract` `Readonly`_itemType

`Protected`_getSerializableProperties

`Protected`_initializableChildCollections

`Protected`_initializeChildren

`Protected`_onDestroy

`Protected`_onInitialize

`Protected`_postInitialize

`Protected`_toPropertyDef