Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Implemented by

Index

Methods

addListener

  • Adds a listener to receive notifications for this event.

    Parameters

    Returns void

getListeners

  • Gets all subscribed listeners.

    Returns IEventListener[]

    a list of listeners.

getName

  • getName(): string
  • Gets the event name.

    Returns string

    the name of the event.

notify

  • notify(correlationId: string, args: Parameters): void
  • 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

  • Removes a listener, so that it no longer receives notifications for this event.

    Parameters

    Returns void

Generated using TypeDoc