Interface HookableEvent<T>

interface HookableEvent<T> {
    addPostHook(hook: PostEventHook<T>): EventHookRemove;
    addPreHook(hook: PreEventHook<T>): EventHookRemove;
    trigger<R>(payload: T, action: (() => Promise<R>)): Promise<R>;
}

Type Parameters

T

Index

Methods

addPostHook addPreHook trigger

Methods

addPostHook

addPostHook(hook): EventHookRemove
Add a hook to be executed after the event's action when the event is triggered.
Parameters
- hook: PostEventHook<T>
  A hook whose callback will be executed.
Returns EventHookRemove
A callback which deletes the added hook.

addPreHook

addPreHook(hook): EventHookRemove
Add a hook to be executed before the event's action when the event is triggered.
Parameters
- hook: PreEventHook<T>
  A hook whose callback will be executed.
Returns EventHookRemove
A callback which deletes the added hook.

trigger

trigger<R>(payload, action): Promise<R>
Runs all hooks of a specific event of the given event type.
Type Parameters
- R
Parameters
- payload: T
  The data which the callback of each hook has access to.
- action: (() => Promise<R>)
  The action to perform.
  - - (): Promise<R>
    - Returns Promise<R>
Returns Promise<R>
A promise of type R.