Home Manual Reference Source Test Repository

Typedef

Static Public Summary
public	PluginConfig: object
public	PluginData: object
public	PluginManagerOptions: object

Static Public

public PluginConfig: object source

Properties:

Name	Type	Attribute	Description
name	string		Defines the name of the plugin; if no `target` entry is present the name doubles as the target (please see target).
target	string	optional	Defines the target NPM module to load or defines a local file (full path or relative to current working directory to load.
instance	string	optional	Defines an existing object instance to use as the plugin.
options	object	optional	Defines an object of options for the plugin.

public PluginData: object source

Properties:

Name	Type	Attribute	Description
name	string		The name of the plugin.
scopedName	string		The name of the plugin with the plugin managers event prepend string.
target	string		Defines the target NPM module to loaded or defines a local file (full path or relative to current working directory to load.
targetEscaped	string		Provides the target, but properly escaped for RegExp usage.
type	string		The type of plugin: `instance`, `require-module`, or `require-path`.
options	object		Defines an object of options for the plugin.
managerEventPrepend	string		The plugin manager event prepend string.

public PluginManagerOptions: object source

Properties:

Name	Type	Attribute	Description
pluginsEnabled	boolean	optional	If false all plugins are disabled.
noEventAdd	boolean	optional	If true this prevents plugins from being added by `plugin:add` and `plugin:add:all` events forcing direct method invocation for addition.
noEventDestroy	boolean	optional	If true this prevents the plugin mananger from being destroyed by `plugin:destroy:manager` forcing direct method invocation for destruction.
noEventRemoval	boolean	optional	If true this prevents plugins from being removed by `plugin:remove` and `plugin:remove:all` events forcing direct method invocation for removal.
throwNoMethod	boolean	optional	If true then when a method fails to be invoked by any plugin an exception will be thrown.
throwNoPlugin	boolean	optional	If true then when no plugin is matched to be invoked an exception will be thrown.