Class Observer

A base Observer implementation.

An Observer is an object that encapsulates information about an interested object with a method that should be called when a particular Notification is broadcast.

In PureMVC, the Observer class assumes these responsibilities:

Encapsulate the notification (callback) method of the interested object.
Encapsulate the notification context (this) of the interested object.
Provide methods for setting the notification method and context.
Provide a method for notifying the interested object.

Observer

Implements

IObserver

Index

Constructors

constructor

new Observer(notify?, context?): Observer
Constructor.

The notification method on the interested object should take one parameter of type Notification
Parameters
- Optionalnotify: null | ((notification: INotification) => void)
  The method to be called when a notification is received. Can be null.
- Optionalcontext: any
  The context in which to call the notifyMethod. Can be null.
Returns Observer
- Defined in patterns/observer/Observer.ts:42

Accessors

notifyContext

get notifyContext(): any
Get the notifyContext

Returns any
The current context or null if no context is set.
Implementation of IObserver.notifyContext
- Defined in patterns/observer/Observer.ts:80
set notifyContext(value): void
Set the notification context.
Parameters
- value: any
  The context to set. Can be null.
Returns void
Implementation of IObserver.notifyContext
- Defined in patterns/observer/Observer.ts:89

notifyMethod

get notifyMethod(): undefined | null | ((notification: INotification) => void)
Get the notification method.

Returns undefined | null | ((notification: INotification) => void)
The current method or null if no method is set.
Implementation of IObserver.notifyMethod
- Defined in patterns/observer/Observer.ts:55
set notifyMethod(value): void
Set the notification method.

The notification method should take one parameter of type Notification.
Parameters
- value: null | ((notification: INotification) => void)
  The method to set for handling notifications. Can be null.
Returns void
Implementation of IObserver.notifyMethod
- Defined in patterns/observer/Observer.ts:69

Methods

compareNotifyContext

compareNotifyContext(object): boolean
Compare an object to the notification context.
Parameters
- object: any
  The object to compare with the observer's context.
Returns boolean
true if the context is the same, otherwise false.
Implementation of IObserver.compareNotifyContext
- Defined in patterns/observer/Observer.ts:109

notifyObserver

notifyObserver(notification): void
Notify the interested object.
Parameters
- notification: INotification
  The notification to send to the observer.
Returns void
Implementation of IObserver.notifyObserver
- Defined in patterns/observer/Observer.ts:99

Class Observer

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Observer

Accessors

notifyContext

Returns any

Parameters

Returns void

notifyMethod

Returns undefined | null | ((notification: INotification) => void)

Parameters

Returns void

Methods

compareNotifyContext

Parameters

Returns boolean

notifyObserver

Parameters

Returns void

Settings

On This Page