ActionEvent

The ActionEvent class is the superclass for all events within actions. This can be used to emit log events within actions.

@group

Events/Action

@returns

The Event instance.

Hierarchy

• Event<{ message: string; metadata: Record<string, unknown> }>
  • ActionEvent

Index

Constructors

• constructor

Properties

• header
• name
• payload

Methods

• registrar

Constructors

constructor

• ActionEvent(name?: string, payload?: { message: string; metadata: Record<string, unknown> }): ActionEvent

• Inherited from Event.constructor

  Parameters

  • optionalname: string

  • optionalpayload: { message: string; metadata: Record<string, unknown> }

  • message: string

  • metadata: Record<string, unknown>

  Returns ActionEvent

Properties

readonlyinheritedheader

header: { timestamp: number }

Inherited from Event.header

Type declaration

• timestamp: number

readonlyinheritedname

name: string

Inherited from Event.name

readonlyinheritedpayload

payload: { message: string; metadata: Record<string, unknown> }

Inherited from Event.payload

Type declaration

• message: string

• metadata: Record<string, unknown>

Methods

staticinheritedregistrar

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

• Inherited from Event.registrar

  The registrar() method is explicitly called by the EventSource decorator for a method to enhance that 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