Interface INotificationCenter

Interface for a notification center that manages dispatching and subscription of notifications.

interface INotificationCenter {
    dispatch(notification: INotification<any>): void;
    subscribe(
        name: string,
        handler: notification_api.onNotification<any>,
    ): IIdentifiable;
    unsubscribe(
        name: string,
        handler: IIdentifiable | notification_api.onNotification<any>,
    ): void;
}

Implemented by

NotificationCenter.NotificationCenter

Index

Methods

dispatch subscribe unsubscribe

Methods

dispatch

dispatch(notification: INotification<any>): void
Dispatches a notification to all subscribed handlers.
Parameters
- notification: INotification<any>
  The notification to dispatch.
Returns void

subscribe(
name: string,
handler: notification_api.onNotification<any>,
): IIdentifiable
Subscribes a handler to a specific notification name.
Parameters
- name: string
  The notification name.
- handler: notification_api.onNotification<any>
  The handler to invoke when the notification is dispatched.
Returns IIdentifiable

unsubscribe

unsubscribe(
name: string,
handler: IIdentifiable | notification_api.onNotification<any>,
): void
Unsubscribes a handler from a specific notification name.
Parameters
- name: string
  The notification name.
- handler: IIdentifiable | notification_api.onNotification<any>
  The handler to remove.
Returns void