ObservableEntity | observable-entities

Base class for observable entitites.

export
class: ObservableEntity

Hierarchy

ObservableEntity

Index

Constructors

constructor

Properties

Accessors

modifyListeners

Methods

Constructors

Protected constructor

new ObservableEntity(): ObservableEntity

- Defined in observable-entity.ts:15
Returns ObservableEntity

Properties

Private _excludedProperties

_excludedProperties: Set<string> = new Set<string>()

Private _modifyListeners

_modifyListeners: Subject<INotifyInfo>[] = []

Accessors

modifyListeners

modifyListeners:

Array of listeners to observe property changes.

readonly
type: {Subject[]}
memberof: ObservableEntity

Methods

addExcludedProperties

addExcludedProperties(...properties: string[]): void

- Defined in observable-entity.ts:53
Provide names of properties that will not be observed.

memberof

ObservableEntity

Parameters
- Rest ...properties: string[]
  
  Properties that will not be observed.
Returns void

Protected proxify

proxify<TEntity>(item: TEntity): TEntity

- Defined in observable-entity.ts:72
Returns proxy of entity with listeners that can observe property changes. Call from ctor to return observable proxy.

example

constructor() { super(); return super.proxify(this); }

template

TEntity

memberof

ObservableEntity

Type parameters
- TEntity: any
Parameters
- item: TEntity
  
  Entity to be proxified.
Returns TEntity

Proxified entity.

Static proxify

proxify<TEntity>(ctor: object): TEntity

- Defined in observable-entity.ts:30
Factory method for creating an observable entity. Returns proxy of entity with listeners that can observe property changes.

static

template

TEntity

memberof

ObservableEntity

Type parameters
- TEntity: any
Parameters
- ctor: object
  
  Class name
  - constructor: function
    - new __type(): TEntity
    - Defined in observable-entity.ts:30
      Returns TEntity
Returns TEntity

Entity proxy that is observable

Generated using TypeDoc