OverlayRegistrationEvent

This event is emitted when a class with @Overlay() decorator is registered. It emits the name of the class.

@example

const myEvent = new OverlayRegistrationEvent('MyClass');
EventService.getInstance().emit(myEvent);

@returns

The Event instance.

Hierarchy

• RegistrationEvent
  • OverlayRegistrationEvent

Index

Constructors

• constructor

Properties

• header
• payload
• userData

Methods

• registrar

Constructors

constructor

• new OverlayRegistrationEvent(payload: string, userData?: object): OverlayRegistrationEvent

• Inherited from RegistrationEvent.constructor

  Parameters

  • payload: string

  • userData: object = {}

  Returns OverlayRegistrationEvent

Properties

readonlyheader

header: { timestamp: number }

Inherited from RegistrationEvent.header

Type declaration

• timestamp: number

readonlypayload

payload: string

Inherited from RegistrationEvent.payload

readonlyuserData

userData: object

Inherited from RegistrationEvent.userData

Methods

staticregistrar

• registrar(eventService: EventService, descriptor: PropertyDescriptor): void

• Overrides RegistrationEvent.registrar

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

  ---

  Parameters

  • eventService: EventService

    Arguments are spread out using the array spread operator.

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

  • descriptor: PropertyDescriptor

  Returns void