Home Manual Reference Source Test Repository
public class | source

PluginEntry

Defines a class holding the data associated with a plugin including it's instance.

Constructor Summary

Public Constructor
public

constructor(name: string, type: string, target: string, instance: Object, eventProxy: EventProxy, options: object)

Instantiates a PluginEntry.

Member Summary

Public Members
public get

Get enabled.

public set

enabled(enabled: boolean): *

Set enabled.

public get

Get associated EventProxy.

public get

Get plugin instance.

public get

name: string: *

Get name.

public get

Get plugin options.

public get

Get plugin target.

public get

Get escaped plugin target.

public get

type: string: *

Get plugin type.

Private Members
private

The plugin enabled state.

private

An EventProxy associated with the plugin wrapping the plugin manager eventbus.

private

The loaded plugin instance.

private

The plugin name.

private

Optional plugin options.

private

The plugin target: a local file path or module name.

private

Provides a sanitized escaped target string suitable for RegExp construction.

private

The plugin type: instance, require-module, require-path.

Public Constructors

public constructor(name: string, type: string, target: string, instance: Object, eventProxy: EventProxy, options: object) source

Instantiates a PluginEntry.

Params:

NameTypeAttributeDescription
name string

The plugin name.

type string

The plugin type: instance, require-module, require-path.

target string

The plugin target: a local file path or module name.

instance Object

The loaded plugin instance.

eventProxy EventProxy

An EventProxy associated with the plugin wrapping the plugin manager eventbus.

options object
  • optional

Optional plugin options.

Public Members

public get enabled: boolean: * source

Get enabled.

Return:

boolean

public set enabled(enabled: boolean): * source

Set enabled.

public get eventProxy: EventProxy: * source

Get associated EventProxy.

Return:

EventProxy

public get instance: Object: * source

Get plugin instance.

Return:

Object

public get name: string: * source

Get name.

Return:

string

public get options: Object: * source

Get plugin options.

Return:

Object

public get target: string: * source

Get plugin target.

Return:

string

public get targetEscaped: string: * source

Get escaped plugin target.

Return:

string

public get type: string: * source

Get plugin type.

Return:

string

Private Members

private _enabled: boolean source

The plugin enabled state.

private _eventProxy: EventProxy source

An EventProxy associated with the plugin wrapping the plugin manager eventbus.

private _instance: Object source

The loaded plugin instance.

private _name: string source

The plugin name.

private _options: Object source

Optional plugin options.

private _target: string source

The plugin target: a local file path or module name.

private _targetEscaped: string source

Provides a sanitized escaped target string suitable for RegExp construction.

private _type: string source

The plugin type: instance, require-module, require-path.