Interface IPageEvent<T>

interface IPageEvent<T> {
    addPostHook(hook: IPostPageEventHook<T>): PageEventHookRemove;
    addPreHook(hook: IPrePageEventHook<T>): PageEventHookRemove;
    trigger<R>(payload: T, action: (() => Promise<R>)): Promise<R>;
}

Type Parameters

T extends IPageEventData

Index

Methods

addPostHook addPreHook trigger

Methods

addPostHook

addPostHook(hook): PageEventHookRemove
Parameters
- hook: IPostPageEventHook<T>
  the hook which defines the callback to run post-event.
Returns PageEventHookRemove
Method
Description
Adds a hook to be executed after a hookable event is triggered.

addPreHook

addPreHook(hook): PageEventHookRemove
Parameters
- hook: IPrePageEventHook<T>
  the hook which defines the callback to run pre-event.
Returns PageEventHookRemove
Method
Description
Adds a hook to be executed before a hookable event is triggered.

trigger

trigger<R>(payload, action): Promise<R>
Type Parameters
- R
Parameters
- payload: T
  is passed as input for any event hooks.
- action: (() => Promise<R>)
  the action to perform.
  - - (): Promise<R>
    - Returns Promise<R>
Returns Promise<R>
Method
Description
run pre-hooks, execute the action, run post hooks.