Interface IEvent

An interface for Events, which are part of the Command design pattern. Events allows to send asynchronious notifications to multiple subscribed listeners.

see: IEventListener

Hierarchy

INotifiable
- IEvent

Implemented by

Event

Index

Methods

Methods

addListener

addListener(listener: IEventListener): void

- Defined in commands/IEvent.ts:32
Adds a listener to receive notifications for this event.

Parameters
- listener: IEventListener
  
  the listener reference to add.
Returns void

getListeners

getListeners(): IEventListener[]

- Defined in commands/IEvent.ts:25
Gets all subscribed listeners.

Returns IEventListener[]

a list of listeners.

getName

getName(): string

- Defined in commands/IEvent.ts:18
Gets the event name.

Returns string

the name of the event.

notify

notify(correlationId: string, args: Parameters): void

Inherited from INotifiable.notify
- Defined in run/INotifiable.ts:32
Notifies the component about occured event.

Parameters
- correlationId: string
  
  (optional) transaction id to trace execution through call chain.
- args: Parameters
  
  notification arguments.
Returns void

removeListener

removeListener(listener: IEventListener): void

- Defined in commands/IEvent.ts:39
Removes a listener, so that it no longer receives notifications for this event.

Parameters
- listener: IEventListener
  
  the listener reference to remove.
Returns void

Generated using TypeDoc