Interface PluginDeployerHandler

interface PluginDeployerHandler {
    deployBackendPlugins(backendPlugins): Promise<undefined | number>;
    deployFrontendPlugins(frontendPlugins): Promise<undefined | number>;
    getDeployedPlugin(pluginId): undefined | DeployedPlugin;
    getDeployedPlugins(): Promise<DeployedPlugin[]>;
    getDeployedPluginsById(pluginId): DeployedPlugin[];
    getPluginDependencies(pluginToBeInstalled): Promise<undefined | PluginDependencies>;
    undeployPlugin(pluginId): Promise<boolean>;
    uninstallPlugin(pluginId): Promise<boolean>;
}

Implemented by

HostedPluginDeployerHandler

Index

Methods

deployBackendPlugins deployFrontendPlugins getDeployedPlugin 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

getDeployedPlugin

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

getDeployedPlugins

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

getDeployedPluginsById

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

getPluginDependencies

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

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:1002

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:997