Interface PluginSupportImpl

Describes the interface that all PluginSupport classes must implement.

interface PluginSupportImpl {
    destroy(opts): Promise<void>;
    setEventbus(opts): void;
    setOptions(options): void;
}

Implemented by

PluginInvokeSupport

Index

Methods

destroy setEventbus setOptions

Methods

destroy

destroy(opts): Promise<void>
Destroys all managed plugins after unloading them.
Parameters
- opts: {
  eventPrepend: string;
  eventbus: Eventbus;
  }
  An options object.
  - eventPrepend: string
    The current event prepend.
  - eventbus: Eventbus
    The eventbus to disassociate.
Returns Promise<void>

setEventbus

setEventbus(opts): void
Sets the eventbus associated with this plugin manager. If any previous eventbus was associated all plugin manager events will be removed then added to the new eventbus. If there are any existing plugins being managed their events will be removed from the old eventbus and then 'onPluginLoad' will be called with the new eventbus.
Parameters
- opts: {
      newEventbus: Eventbus;
      newPrepend: string;
      oldEventbus: Eventbus;
      oldPrepend: string;
  }
  An options object.
  - newEventbus: Eventbus
    The new eventbus to associate.
  - newPrepend: string
    The new event prepend.
  - oldEventbus: Eventbus
    The old eventbus to disassociate.
  - oldPrepend: string
    The old event prepend.
Returns void

setOptions

setOptions(options): void
Set optional parameters.
Parameters
- options: PluginManagerOptions
  Defines optional parameters to set.
Returns void