Class PluginModule

Hierarchy

ModuleBase
- PluginModule

Index

Constructors

Methods

register add get _init

Properties

_postMessage _moduleLoader _plugins _factory

Constructors

constructor

new PluginModule(baseArgs: {
postMessage: PostMessageChannel;
moduleLoader: ModuleLoaderInterface;
}, conf?: PluginModuleConfig): PluginModule
Parameters
- baseArgs: {
  postMessage: PostMessageChannel;
  moduleLoader: ModuleLoaderInterface;
  }
  - postMessage: PostMessageChannel
  - moduleLoader: ModuleLoaderInterface
- conf: PluginModuleConfig = {}
Returns PluginModule
Overrides ModuleBase.constructor
- Defined in src/module/PluginModule.ts:33

Methods

register

register(plugins: Record<string, Object>): void
Register a set of plugin and solve the dependancy

Returns
Parameters
- plugins: Record<string, Object>
  
  Class of each plugins with their respective names in keys
Returns void
- Defined in src/module/PluginModule.ts:47

add

add(name: string, plugin: Object): boolean
Add one plugin with his name and his class

Returns
If the plugin was added and instanciate or false if it's already present
Parameters
- name: string
  
  The plugin name/key
- plugin: Object
  
  Class of the plugin to instanciate
Returns boolean
- Defined in src/module/PluginModule.ts:70

get

get(name: string): any
Get the in stance of a plugin

Returns
The instance of the plugin
Parameters
- name: string
  
  The name of the plugin to get
Returns any
- Defined in src/module/PluginModule.ts:84

`Private` _init

_init(name: string): boolean
Instanciate the plugin (with custom plugin factory if it was registered)

Returns
If the plugin was instanciate
Parameters
- name: string
  
  Plugin name/key to instanciate
Returns boolean
- Defined in src/module/PluginModule.ts:102

Properties

`Protected` _postMessage

_postMessage: PostMessageChannel

`Protected` _moduleLoader

_moduleLoader: ModuleLoaderInterface

`Private` _plugins

_plugins: Map<any, any> = ...

`Private` _factory

_factory: Factory

Generated using TypeDoc