CommitHookEvent

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

@group

Events/Hooks/Commit

@returns

The Event instance.

Hierarchy

• HookEvent
  • CommitHookEvent
    • PostCommitHookCallbackDoneEvent
    • PreCommitHookCallbackDoneEvent

Index

Constructors

• constructor

Properties

• header
• name
• payload

Methods

• registrar

Constructors

constructor

• CommitHookEvent(name?: string, payload?: void): CommitHookEvent

• Inherited from HookEvent.constructor

  Parameters

  • optionalname: string

  • optionalpayload: void

  Returns CommitHookEvent

Properties

readonlyinheritedheader

header: { timestamp: number }

Inherited from HookEvent.header

Type declaration

• timestamp: number

readonlyinheritedname

name: string

Inherited from HookEvent.name

readonlyinheritedpayload

payload: void

Inherited from HookEvent.payload

Methods

staticinheritedregistrar

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

• Inherited from HookEvent.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