Class ObservableObject

Base class for observable objects - objects supporting events

ObservableObject

Hierarchy (view full)

ObservableObject
- DataSourceObject

Index

Constructors

Properties

_localPromises _promises _registrations _timeoutIDs isObservable uniqueID

Methods

_getListeners addEventListener cleanUp cleanUpPromises getSimpleCopy initialize localPromise notifyChange raiseEvent removeEventListener requestTimeout

Events

Constructors

constructor

new ObservableObject(obj?, params?): ObservableObject
Parameters
- Optional obj: any
- Optional params: any
Returns ObservableObject
- Defined in src/helpers/observableObject.ts:27

Properties

`Private` _localPromises

_localPromises: any[]

Undocumented

_promises

_promises: any

Undocumented

`Private` _registrations

_registrations: AnyDict

Undocumented

`Private` _timeoutIDs

_timeoutIDs: any[]

Undocumented

isObservable

isObservable: boolean

Undocumented

uniqueID

uniqueID: string

Undocumented

Methods

_getListeners

_getListeners(type, useCapture): any
Parameters
- type: any
- useCapture: any
Returns any
Undocumented
- Defined in src/helpers/observableObject.ts:39

addEventListener

addEventListener(type, listener, useCapture): void
Parameters
- type: any
- listener: any
- useCapture: any
Returns void
Undocumented
- Defined in src/helpers/observableObject.ts:46

cleanUp

cleanUp(): void
Returns void
Undocumented
- Defined in src/helpers/observableObject.ts:132

cleanUpPromises

cleanUpPromises(): void
Returns void
Undocumented
- Defined in src/helpers/observableObject.ts:95

getSimpleCopy

getSimpleCopy(): any
Returns any
Undocumented
- Defined in src/helpers/observableObject.ts:73

initialize

initialize(obj, params): void
Parameters
- obj: any
- params: any
Returns void
Undocumented
- Defined in src/helpers/observableObject.ts:31

localPromise

localPromise(promise): any
Parameters
- promise: any
Returns any
Undocumented
- Defined in src/helpers/observableObject.ts:84

notifyChange

notifyChange(params): void
Parameters
- params: any
Returns void
Undocumented
- Defined in src/helpers/observableObject.ts:69

raiseEvent

raiseEvent(type, params): void
Parameters
- type: any
- params: any
Returns void
Undocumented
- Defined in src/helpers/observableObject.ts:60

removeEventListener

removeEventListener(type, listener, useCapture): void
Parameters
- type: any
- listener: any
- useCapture: any
Returns void
Undocumented
- Defined in src/helpers/observableObject.ts:53

requestTimeout

requestTimeout(callback, timeMS, callbackID?, useFirst?): number
Parameters
- callback: any
- timeMS: any
- Optional callbackID: any
- Optional useFirst: boolean
Returns number
Undocumented
- Defined in src/helpers/observableObject.ts:110

Events

event_change

event_change: ((...params) => void)

Type declaration

- (...params): void
- Parameters
  - Rest ...params: unknown[]
  Returns void