Class Hooks

Hook class.

Hierarchy (View Summary)

AsyncHooks
- Hooks

Index

Constructors

Properties

_hooks _lifecycleHookScore

Methods

_appStart _appStop _prepareHook addHook commandAfter commandBefore removeHook runHook serverStart serverStop

Constructors

constructor

new Hooks(): Hooks

Returns Hooks

Inherited from AsyncHooks.constructor

Properties

_hooks

_hooks: Record<string, Hook[]>

_lifecycleHookScore

_lifecycleHookScore: number = 0

Methods

_appStart

_appStart(app: App): Promise<void>
Parameters
- app: App
Returns Promise<void>
- Defined in mojo.js-main/src/hooks.ts:45

_appStop

_appStop(app: App): Promise<void>
Parameters
- app: App
Returns Promise<void>
- Defined in mojo.js-main/src/hooks.ts:50

_prepareHook

_prepareHook(chain: Hook[]): (...args: any[]) => Promise<any>
Parameters
- chain: Hook[]
Returns (...args: any[]) => Promise<any>
Inherited from AsyncHooks._prepareHook
- Defined in mojo.js-main/node_modules/@mojojs/util/lib/util.d.ts:44

addHook

addHook(name: string, fn: Hook): void
Add hook.
Parameters
- name: string
- fn: Hook
Returns void
Inherited from AsyncHooks.addHook
- Defined in mojo.js-main/node_modules/@mojojs/util/lib/util.d.ts:35

commandAfter

commandAfter(app: App, commandArgs: string[]): Promise<void>
Run command:after hook with dependencies. Note that this method is EXPERIMENTAL and might change without warning!
Parameters
- app: App
- commandArgs: string[]
Returns Promise<void>
- Defined in mojo.js-main/src/hooks.ts:24

commandBefore

commandBefore(app: App, commandArgs: string[]): Promise<any>
Run command:before hook with dependencies. Note that this method is EXPERIMENTAL and might change without warning!
Parameters
- app: App
- commandArgs: string[]
Returns Promise<any>
- Defined in mojo.js-main/src/hooks.ts:14

removeHook

removeHook(name: string, fn?: Hook): void
Remove one or more hook handlers.
Parameters
- name: string
- Optionalfn: Hook
Returns void
Inherited from AsyncHooks.removeHook
- Defined in mojo.js-main/node_modules/@mojojs/util/lib/util.d.ts:39

runHook

runHook(name: string, ...args: any[]): Promise<any>
Run hook.
Parameters
- name: string
- ...args: any[]
Returns Promise<any>
Inherited from AsyncHooks.runHook
- Defined in mojo.js-main/node_modules/@mojojs/util/lib/util.d.ts:43

serverStart

serverStart(app: App): Promise<void>
Run server:start hook with dependencies. Note that this method is EXPERIMENTAL and might change without warning!
Parameters
- app: App
Returns Promise<void>
- Defined in mojo.js-main/src/hooks.ts:32

serverStop

serverStop(app: App): Promise<void>
Run server:stop hook with dependencies. Note that this method is EXPERIMENTAL and might change without warning!
Parameters
- app: App
Returns Promise<void>
- Defined in mojo.js-main/src/hooks.ts:40