Event <T>

The Event class is the superclass for all events. An event is generated when something important happens in Octo. The body of the event contains a header, a payload, and an optional user data.

Warning

It is not a good practice to create an event from this class directly, but should rather create one from one of the subclasses. This promotes a more accurate classification of events.

@example

const myEvent = new Event<string>('my payload', { key: 'value' });
EventService.getInstance().emit(myEvent);

@returns

The Event instance.

Hierarchy

• Event
  • ErrorEvent
  • HookEvent
  • ModuleEvent
  • RegistrationEvent
  • SerializationEvent
  • TransactionEvent

Index

Constructors

• constructor

Properties

• header
• payload
• userData

Methods

• registrar

Constructors

constructor

• new Event<T>(payload: T, userData?: object): Event<T>

• Type parameters

  • T

  Parameters

  • payload: T

  • userData: object = {}

  Returns Event<T>

Properties

readonlyheader

header: { timestamp: number }

Type declaration

• timestamp: number

readonlypayload

payload: T

readonlyuserData

userData: object

Methods

staticregistrar

• registrar(...args: [EventService, PropertyDescriptor]): void

• The registrar() method is explicitly called by the EventSource decorator for a method to enhance the method to auto-emit events.

  ---

  Parameters

  • rest...args: [EventService, PropertyDescriptor]

    Arguments are spread out using the array spread operator.

    • args[0] - Instance of EventService.
    • args[1] - PropertyDescriptor.

  Returns void