CommitHookEvent

The CommitHookEvent class is the superclass for all events emitting in relation to commit hooks.

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 CommitHookEvent();
EventService.getInstance().emit(myEvent);

@returns

The Event instance.

Hierarchy

• HookEvent
  • CommitHookEvent
    • CommitHookCallbackDoneEvent
    • PostCommitHookCallbackDoneEvent
    • PreCommitHookCallbackDoneEvent

Index

Constructors

• constructor

Properties

• header
• payload
• userData

Methods

• registrar

Constructors

constructor

• new CommitHookEvent(payload: void, userData?: object): CommitHookEvent

• Inherited from HookEvent.constructor

  Parameters

  • payload: void

  • userData: object = {}

  Returns CommitHookEvent

Properties

readonlyheader

header: { timestamp: number }

Inherited from HookEvent.header

Type declaration

• timestamp: number

readonlypayload

payload: void

Inherited from HookEvent.payload

readonlyuserData

userData: object

Inherited from HookEvent.userData

Methods

staticregistrar

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

• Inherited from HookEvent.registrar

  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