Skip to main content

PluginEntry

Defines a class holding the data associated with a plugin including its instance.

Index

Constructors

constructor

  • new PluginEntry(name: string, data: any, instance: any, eventProxy: EventEmitter): default
  • Instantiates a PluginEntry.


    Parameters

    • name: string

      The plugin name.

    • data: any

      Data describing the plugin, manager, and optional module data.

    • instance: any

      The loaded plugin instance.

    • eventProxy: EventEmitter

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

    Returns default

Accessors

data

  • get data(): any
  • Get plugin data.


    Returns any

enabled

  • get enabled(): boolean
  • set enabled(enabled: boolean): void
  • Get enabled.


    Returns boolean

  • Set enabled.


    Parameters

    • enabled: boolean

      New enabled state.

    Returns void

eventProxy

  • get eventProxy(): EventEmitter
  • set eventProxy(eventProxy: EventEmitter): void
  • Get associated EventProxy.


    Returns EventEmitter

  • Parameters

    • eventProxy: EventEmitter

    Returns void

instance

  • get instance(): any
  • Get plugin instance.


    Returns any

name

  • get name(): string
  • Get plugin name.


    Returns string

Methods

staticescape

  • escape(value: string): string
  • Provides a convenience method to escape file paths.


    Parameters

    • value: string

      A string to escape.

    Returns string