Class PluginManager

constructor

• new PluginManager(__namedParameters: PluginManagerOptions): PluginManager

  Parameters

  • __namedParameters: PluginManagerOptions

  Returns PluginManager

Readonlyactivation

Readonlycontext

Readonlyregistry

active

• get active(): Live<readonly string[]>

  Ids of modules which are currently active.

  Returns Live<readonly string[]>

  Reactive

core

• get core(): Live<readonly string[]>

  Ids of plugins that are core and cannot be removed.

  Returns Live<readonly string[]>

  Reactive

enabled

• get enabled(): Live<readonly string[]>

  Ids of plugins that are currently enabled.

  Returns Live<readonly string[]>

  Reactive

eventsFired

• get eventsFired(): Live<readonly string[]>

  Ids of events which have been fired.

  Returns Live<readonly string[]>

  Reactive

modules

• get modules(): Live<readonly PluginModule[]>

  Modules of plugins which are currently enabled.

  Returns Live<readonly PluginModule[]>

  Reactive

pendingReset

• get pendingReset(): Live<readonly string[]>

  Ids of modules which are pending reset.

  Returns Live<readonly string[]>

  Reactive

plugins

• get plugins(): Live<readonly Plugin[]>

  Plugins that are currently registered.

  Returns Live<readonly Plugin[]>

  Reactive

activate

• activate(event: string | ActivationEvent): Promise<boolean>

  Activates plugins based on the activation event.

  Parameters

  • event: string | ActivationEvent

    The activation event.

  Returns Promise<boolean>

  Whether the activation was successful.

add

• add(id: string): Promise<boolean>

  Adds a plugin to the manager via the plugin loader.

  Parameters

  • id: string

    The id of the plugin.

  Returns Promise<boolean>

deactivate

• deactivate(id: string): Promise<boolean>

  Deactivates all of the modules for a plugin.

  Parameters

  • id: string

    The id of the plugin.

  Returns Promise<boolean>

  Whether the deactivation was successful.

disable

• disable(id: string): Promise<boolean>

  Disables a plugin.

  Parameters

  • id: string

    The id of the plugin.

  Returns Promise<boolean>

enable

• enable(id: string): Promise<boolean>

  Enables a plugin.

  Parameters

  • id: string

    The id of the plugin.

  Returns Promise<boolean>

remove

• remove(id: string): boolean

  Removes a plugin from the manager.

  Parameters

  • id: string

    The id of the plugin.

  Returns boolean

reset

• reset(event: string | ActivationEvent): Promise<boolean>

  Re-activates the modules that were activated by the event.

  Parameters

  • event: string | ActivationEvent

    The activation event.

  Returns Promise<boolean>

  Whether the reset was successful.