Interface PluginDeployerHandler

interface PluginDeployerHandler {
    deployBackendPlugins(backendPlugins): Promise<undefined | number>;
    deployFrontendPlugins(frontendPlugins): Promise<undefined | number>;
    disablePlugin(pluginId): Promise<boolean>;
    enablePlugin(pluginId): Promise<boolean>;
    getDeployedPlugin(pluginId): undefined | DeployedPlugin;
    getDeployedPluginIds(): Promise<readonly `${string}.${string}@${string}`[]>;
    getDeployedPlugins(): Promise<DeployedPlugin[]>;
    getDeployedPluginsById(pluginId): DeployedPlugin[];
    getPluginDependencies(pluginToBeInstalled): Promise<undefined | PluginDependencies>;
    undeployPlugin(pluginId): Promise<boolean>;
    uninstallPlugin(pluginId): Promise<boolean>;
}

Implemented by

PluginDeployerHandlerImpl

Index

Methods

deployBackendPlugins deployFrontendPlugins disablePlugin enablePlugin getDeployedPlugin getDeployedPluginIds getDeployedPlugins getDeployedPluginsById getPluginDependencies undeployPlugin uninstallPlugin

Methods

deployBackendPlugins

deployBackendPlugins(backendPlugins): Promise<undefined | number>
Parameters
- backendPlugins: PluginDeployerEntry[]
Returns Promise<undefined | number>
- Defined in packages/plugin-ext/src/common/plugin-protocol.ts:987

deployFrontendPlugins

deployFrontendPlugins(frontendPlugins): Promise<undefined | number>
Parameters
- frontendPlugins: PluginDeployerEntry[]
Returns Promise<undefined | number>
- Defined in packages/plugin-ext/src/common/plugin-protocol.ts:986

disablePlugin

disablePlugin(pluginId): Promise<boolean>
Marks the given plugins as "disabled". While the plugin remains installed, it will no longer be used. Has no effect if the plugin is not installed
Parameters
- pluginId: `${string}.${string}@${string}`
  the plugin to disable
Returns Promise<boolean>
whether the plugin was installed, enabled and could be disabled
- Defined in packages/plugin-ext/src/common/plugin-protocol.ts:1014

enablePlugin

enablePlugin(pluginId): Promise<boolean>
Marks the given plugins as "enabled". Has no effect if the plugin is not installed.
Parameters
- pluginId: `${string}.${string}@${string}`
  the plugin to enabled
Returns Promise<boolean>
whether the plugin was installed, disabled and could be enabled
- Defined in packages/plugin-ext/src/common/plugin-protocol.ts:1021

getDeployedPlugin

getDeployedPlugin(pluginId): undefined | DeployedPlugin
Parameters
- pluginId: `${string}.${string}@${string}`
Returns undefined | DeployedPlugin
- Defined in packages/plugin-ext/src/common/plugin-protocol.ts:993

getDeployedPluginIds

getDeployedPluginIds(): Promise<readonly `${string}.${string}@${string}`[]>
Returns Promise<readonly `${string}.${string}@${string}`[]>
- Defined in packages/plugin-ext/src/common/plugin-protocol.ts:988

getDeployedPlugins

getDeployedPlugins(): Promise<DeployedPlugin[]>
Returns Promise<DeployedPlugin[]>
- Defined in packages/plugin-ext/src/common/plugin-protocol.ts:990

getDeployedPluginsById

getDeployedPluginsById(pluginId): DeployedPlugin[]
Parameters
- pluginId: string
Returns DeployedPlugin[]
- Defined in packages/plugin-ext/src/common/plugin-protocol.ts:991

getPluginDependencies

getPluginDependencies(pluginToBeInstalled): Promise<undefined | PluginDependencies>
Parameters
- pluginToBeInstalled: PluginDeployerEntry
Returns Promise<undefined | PluginDependencies>
- Defined in packages/plugin-ext/src/common/plugin-protocol.ts:1006

undeployPlugin

undeployPlugin(pluginId): Promise<boolean>
Removes the plugin from the locations to which it had been deployed. This operation is not safe - references to deleted assets may remain.
Parameters
- pluginId: `${string}.${string}@${string}`
Returns Promise<boolean>
- Defined in packages/plugin-ext/src/common/plugin-protocol.ts:1004

uninstallPlugin

uninstallPlugin(pluginId): Promise<boolean>
Removes the plugin from the location it originally resided on disk. Unless --uncompressed-plugins-in-place is passed to the CLI, this operation is safe.
Parameters
- pluginId: `${string}.${string}@${string}`
Returns Promise<boolean>
- Defined in packages/plugin-ext/src/common/plugin-protocol.ts:998