Class Kit

Index

Methods

getPlugin getPlugins init off on registerPlugin setResources

Methods

`Static`getPlugin

getPlugin<T = KitPluginLike>(pName: string): undefined | T
Gets a plugin by name.
Type Parameters
- T = KitPluginLike
Parameters
- pName: string
  String name of the plugin to retrieve.
Returns undefined | T
- Defined in src/kit.ts:119

`Static`getPlugins

getPlugins(): string[]
Lists all registered plugins.

Returns string[]
- Defined in src/kit.ts:130

`Static`init

init<T = any>(pPlugins: (T | KitPluginConstructor<T, any[]>)[]): void
Initialize the Kit class with plugins.
Type Parameters
- T = any
Parameters
- pPlugins: (T | KitPluginConstructor<T, any[]>)[]
  An array of plugins to initialize.
Returns void
Deprecated
Use registerPlugin instead.
- Defined in src/kit.ts:41

`Static`off

off(pPluginName: string, pEventName: string, pListener: Listener): void
Removes an event listener.
Parameters
- pPluginName: string
  The plugin namespace.
- pEventName: string
  The event name.
- pListener: Listener
  The listener to remove.
Returns void
- Defined in src/kit.ts:169

`Static`on

on(pPluginName: string, pEventName: string, pListener: Listener): void
Listen for an event.
Parameters
- pPluginName: string
  The plugin namespace.
- pEventName: string
  The event name.
- pListener: Listener
  The listener to call when the event is emitted.
Returns void
- Defined in src/kit.ts:155

`Static`registerPlugin

registerPlugin<T, C extends KitPluginConstructor<T, any[]>>(
pPlugin: C,
...args: ConstructorParameters<C>,
): T
Register a plugin with the Kit class. Accepts a plugin constructor (with optional constructor arguments), an instantiated plugin instance, or an array of plugins.
Type Parameters
- T
- C extends KitPluginConstructor<T, any[]>
Parameters
- pPlugin: C
  The plugin constructor, plugin instance, or array of plugins to register.
- ...args: ConstructorParameters<C>
  Optional arguments passed to the plugin constructor when instantiating.
Returns T
- Defined in src/kit.ts:53
registerPlugin<T extends object>(pPlugin: T): T
Register a plugin with the Kit class. Accepts a plugin constructor (with optional constructor arguments), an instantiated plugin instance, or an array of plugins.
Type Parameters
- T extends object
Parameters
- pPlugin: T
  The plugin constructor, plugin instance, or array of plugins to register.
Returns T
- Defined in src/kit.ts:57
registerPlugin<T>(pPlugin: (T | KitPluginConstructor<T, any[]>)[]): T[]
Register a plugin with the Kit class. Accepts a plugin constructor (with optional constructor arguments), an instantiated plugin instance, or an array of plugins.
Type Parameters
- T
Parameters
- pPlugin: (T | KitPluginConstructor<T, any[]>)[]
  The plugin constructor, plugin instance, or array of plugins to register.
Returns T[]
- Defined in src/kit.ts:60
registerPlugin<T>(pPlugin: T | KitPluginConstructor<T, any[]>): T
Register a plugin with the Kit class. Accepts a plugin constructor (with optional constructor arguments), an instantiated plugin instance, or an array of plugins.
Type Parameters
- T
Parameters
- pPlugin: T | KitPluginConstructor<T, any[]>
  The plugin constructor, plugin instance, or array of plugins to register.
Returns T
- Defined in src/kit.ts:63

`Static`setResources

setResources(pResourceJson: Record<string, ResourceData[]>): Promise<void>
Sets the resources found in resources and preloads all interfaces found.
Parameters
- pResourceJson: Record<string, ResourceData[]>
Returns Promise<void>
- Defined in src/kit.ts:200