Class Kit

Index

Methods

getPlugin getPlugins init off on registerPlugin setResources

Methods

`Static`getPlugin

getPlugin<T extends KitPlugin>(pName: string): undefined | T
Gets a plugin by name.
Type Parameters
- T extends KitPlugin
Parameters
- pName: string
  String name of the plugin to retrieve.
Returns undefined | T
- Defined in kit.ts:94

`Static`getPlugins

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

Returns string[]
- Defined in kit.ts:105

`Static`init

init<T extends KitPlugin>(pPlugins: KitPluginConstructor<T>[]): void
Initialize the Kit class with plugins.
Type Parameters
- T extends KitPlugin
Parameters
- pPlugins: KitPluginConstructor<T>[]
  An array of plugins to initialize.
Returns void
Deprecated
Use registerPlugin instead.
- Defined in 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 kit.ts:144

`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 kit.ts:130

`Static`registerPlugin

registerPlugin<T extends KitPlugin>(pPlugin: KitPluginConstructor<T>): T
Register a plugin with the Kit class.
Type Parameters
- T extends KitPlugin
Parameters
- pPlugin: KitPluginConstructor<T>
  The plugin to register.
Returns T
- Defined in kit.ts:51
registerPlugin<T extends KitPlugin>(pPlugin: KitPluginConstructor<T>[]): T[]
Register a plugin with the Kit class.
Type Parameters
- T extends KitPlugin
Parameters
- pPlugin: KitPluginConstructor<T>[]
  The plugin to register.
Returns T[]
- Defined in kit.ts:52

`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 kit.ts:175