Class Notifier<E>`Abstract`

A base class that can be listened to, and dispatch events.

Type Parameters

E

Hierarchy (view full)

Notifier

Index

Constructors

Properties

Methods

addEventListener dispatchEvent dispatchToListener removeEventListener

Constructors

constructor

new Notifier<E>(): Notifier<E>
Type Parameters
- E
Returns Notifier<E>

Properties

`Protected` `Readonly`listeners

listeners: ConcurrentCollection<Listener<E>> = ...

Methods

addEventListener

addEventListener(listener): void
Listen to events from this helper. Duplicate listeners allowed.
Parameters
- listener: Listener<E>
Returns void
- Defined in src/helpers/Notifier.ts:19

`Protected`dispatchEvent

dispatchEvent(event): void
Dispatch an event to all listeners.
Parameters
- event: E
Returns void
- Defined in src/helpers/Notifier.ts:46

`Protected`dispatchToListener

dispatchToListener(event, listener): void
Dispatch an event to a specific listener. Listener does not have to be added
Parameters
- event: E
- listener: Listener<E>
Returns void
- Defined in src/helpers/Notifier.ts:37

removeEventListener

removeEventListener(listener): boolean
Stop listening to events from this helper. If a duplicate listener is removed, only one is removed.
Parameters
- listener: Listener<E>
Returns boolean
True if a listener was removed, false otherwise.
- Defined in src/helpers/Notifier.ts:29