Class Observable

The Observable class is a simple implementation of the Observable pattern. The Observable object allows the user to add or remove Observers.

Index

Constructors

Accessors

Methods

add clear remove

Constructors

constructor

new Observable(): Observable
Constructor. Generates an id for the Observable.

Returns Observable
- Defined in util/observable.ts:13

Accessors

id

get id(): string
Retrieves The string id for the Observable

Returns string
The string id for the Observable
- Defined in util/observable.ts:37

Methods

add

add(callback): Observer
Adds an Observer to the Observable
Parameters
- callback: ((name, value?) => void)
  Function to be triggered when the Observer is notified
  - - (name, value?): void
    - Parameters
      name: string
      Optional value: unknown
      Returns void
Returns Observer
- Defined in util/observable.ts:20

clear

clear(): void
Clears the list of observers

Returns void
- Defined in util/observable.ts:43

remove

remove(observer): boolean
Removes an individual observer
Parameters
- observer: Observer
  The object to remove
Returns boolean
True if the Observer is removed, false otherwise.
- Defined in util/observable.ts:29

Generated using TypeDoc