Interface INotificationManager

Manages test and assertion event notifications to registered listeners. The notification manager is responsible for:

Registering and removing listeners
Iterating over listeners when events occur
Aggregating listener results into a unified action

Since

0.2.0

interface INotificationManager {
    addListener(listener: IListener): IRemovable;
    hasListeners?(): boolean;
    notifyAssertion(context: ICachedValue<IAssertionContext>): INotifyResult;
    notifyDone(
        event: ListenerEvent,
        context: ICachedValue<IListenerContext>,
    ): INotifyResult;
    notifyStart(
        event: ListenerEvent,
        context: ICachedValue<IListenerContext>,
    ): INotifyResult;
    removeListener(listener: IListener): void;
    reset(): void;
}

Index

Methods

addListener hasListeners? notifyAssertion notifyDone notifyStart removeListener reset

Methods

addListener

addListener(listener: IListener): IRemovable
Add a listener to receive notifications
Parameters
- listener: IListener
  The listener to add
Returns IRemovable
A removable handle to unregister the listener
- Defined in interfaces/INotificationManager.ts:32

`Optional`hasListeners

hasListeners?(): boolean
Identifies whether this manager, or any parent manager it was created with, currently has at least one registered listener. Callers use this to avoid building the (lazily evaluated) notification context when nothing would ever read it.

Returns boolean
true when at least one listener is registered in this manager or its parent chain
- Defined in interfaces/INotificationManager.ts:74

notifyAssertion

notifyAssertion(context: ICachedValue<IAssertionContext>): INotifyResult
Notify all listeners that an assertion evaluation occurred
Parameters
- context: ICachedValue<IAssertionContext>
  Lazy evaluation context with results (evaluated only if listeners exist)
Returns INotifyResult
Aggregated notification action from all listeners, or null when no listener answered with one
- Defined in interfaces/INotificationManager.ts:61

notifyDone

notifyDone(
event: ListenerEvent,
context: ICachedValue<IListenerContext>,
): INotifyResult
Notify all listeners that an event has completed
Parameters
- event: ListenerEvent
  The type of event
- context: ICachedValue<IListenerContext>
  Lazy context containing event-specific details and results (evaluated only if listeners exist)
Returns INotifyResult
Aggregated notification action from all listeners, or null when no listener answered with one
- Defined in interfaces/INotificationManager.ts:54

notifyStart

notifyStart(
event: ListenerEvent,
context: ICachedValue<IListenerContext>,
): INotifyResult
Notify all listeners that an event is starting
Parameters
- event: ListenerEvent
  The type of event
- context: ICachedValue<IListenerContext>
  Lazy context containing event-specific details (evaluated only if listeners exist)
Returns INotifyResult
Aggregated notification action from all listeners, or null when no listener answered with one
- Defined in interfaces/INotificationManager.ts:46

removeListener

removeListener(listener: IListener): void
Remove a listener
Parameters
- listener: IListener
  The listener to remove
Returns void
- Defined in interfaces/INotificationManager.ts:38

reset

reset(): void
Reset the notification manager, clearing all listeners

Returns void
- Defined in interfaces/INotificationManager.ts:66