@vttforge/types / HooksApi
Interface: HooksApi ​
The Hooks global.
A known name infers its arguments. A render<Class> or close<Class> name a package invents falls to the application shape, since that is what those hooks always carry. Anything else is open, because a package may call Hooks.callAll with a name of its own.
Methods ​
call() ​
Call Signature ​
call<
K>(event, ...args):boolean
Stops at the first listener that returns false.
Type Parameters ​
K ​
K extends keyof HookMap
Parameters ​
event ​
K
args ​
...HookMap[K]
Returns ​
boolean
Call Signature ​
call(
event, ...args):boolean
Parameters ​
event ​
string
args ​
...readonly unknown[]
Returns ​
boolean
callAll() ​
Call Signature ​
callAll<
K>(event, ...args):boolean
Runs every listener, whatever they return.
Type Parameters ​
K ​
K extends keyof HookMap
Parameters ​
event ​
K
args ​
...HookMap[K]
Returns ​
boolean
Call Signature ​
callAll(
event, ...args):boolean
Parameters ​
event ​
string
args ​
...readonly unknown[]
Returns ​
boolean
off() ​
off(
event,idOrFn):boolean
Pass the id on returned, or the same function reference.
Parameters ​
event ​
string
idOrFn ​
number | HookCallback<readonly unknown[]>
Returns ​
boolean
on() ​
Call Signature ​
on<
K>(event,fn):number
Type Parameters ​
K ​
K extends keyof HookMap
Parameters ​
event ​
K
fn ​
HookCallback<HookMap[K]>
Returns ​
number
Call Signature ​
on(
event,fn):number
Parameters ​
event ​
`render${string}`
fn ​
HookCallback<[ApplicationV2Members, HTMLElement, ApplicationRenderContext, ApplicationRenderOptions]>
Returns ​
number
Call Signature ​
on(
event,fn):number
Parameters ​
event ​
`preRender${string}`
fn ​
HookCallback<[ApplicationV2Members, ApplicationRenderContext, ApplicationRenderOptions]>
Returns ​
number
Call Signature ​
on(
event,fn):number
Parameters ​
event ​
`close${string}`
fn ​
HookCallback<[ApplicationV2Members]>
Returns ​
number
Call Signature ​
on(
event,fn):number
Parameters ​
event ​
string
fn ​
Returns ​
number
once() ​
Call Signature ​
once<
K>(event,fn):number
Type Parameters ​
K ​
K extends keyof HookMap
Parameters ​
event ​
K
fn ​
HookCallback<HookMap[K]>
Returns ​
number
Call Signature ​
once(
event,fn):number
Parameters ​
event ​
`render${string}`
fn ​
HookCallback<[ApplicationV2Members, HTMLElement, ApplicationRenderContext, ApplicationRenderOptions]>
Returns ​
number
Call Signature ​
once(
event,fn):number
Parameters ​
event ​
string
fn ​
Returns ​
number