Class PluginDeployerHandlerImpl

Implements

PluginDeployerHandler

Constructors

constructor

new PluginDeployerHandlerImpl(): PluginDeployerHandlerImpl
Returns PluginDeployerHandlerImpl

Properties

`Private` backendPluginsMetadataDeferred

backendPluginsMetadataDeferred: Deferred<void> = ...

`Private` `Readonly` deployedBackendPlugins

deployedBackendPlugins: Map<`${string}.${string}@${string}`, DeployedPlugin> = ...

Managed plugin metadata backend entries.

`Private` `Readonly` deployedFrontendPlugins

deployedFrontendPlugins: Map<`${string}.${string}@${string}`, DeployedPlugin> = ...

Managed plugin metadata frontend entries.

`Private` `Readonly` deployedLocations

deployedLocations: Map<`${string}.${string}@${string}`, Set<string>> = ...

`Private` frontendPluginsMetadataDeferred

frontendPluginsMetadataDeferred: Deferred<void> = ...

`Private` `Readonly` localizationService

localizationService: HostedPluginLocalizationService

`Protected` `Readonly` logger

logger: ILogger

`Private` `Readonly` reader

reader: HostedPluginReader

`Protected` `Readonly` sourceLocations

sourceLocations: Map<`${string}.${string}@${string}`, Set<string>> = ...

`Protected` `Readonly` stopwatch

stopwatch: Stopwatch

`Protected` `Readonly` uninstallationManager

uninstallationManager: PluginUninstallationManager

Methods

deployBackendPlugins

deployBackendPlugins(backendPlugins): Promise<number>
Parameters
- backendPlugins: PluginDeployerEntry[]
Returns Promise<number>
Implementation of PluginDeployerHandler.deployBackendPlugins
- Defined in packages/plugin-ext/src/hosted/node/plugin-deployer-handler-impl.ts:146

deployFrontendPlugins

deployFrontendPlugins(frontendPlugins): Promise<number>
Parameters
- frontendPlugins: PluginDeployerEntry[]
Returns Promise<number>
Implementation of PluginDeployerHandler.deployFrontendPlugins
- Defined in packages/plugin-ext/src/hosted/node/plugin-deployer-handler-impl.ts:136

`Protected` deployPlugin

deployPlugin(entry, entryPoint): Promise<boolean>
Parameters
- entry: PluginDeployerEntry
- entryPoint: keyof PluginEntryPoint
Returns Promise<boolean>
whether the plugin is deployed after running this function. If the plugin was already installed, will still return true.

Throws
never! in order to isolate plugin deployment.
- Defined in packages/plugin-ext/src/hosted/node/plugin-deployer-handler-impl.ts:162

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
Implementation of PluginDeployerHandler.disablePlugin
- Defined in packages/plugin-ext/src/hosted/node/plugin-deployer-handler-impl.ts:282

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
Implementation of PluginDeployerHandler.enablePlugin
- Defined in packages/plugin-ext/src/hosted/node/plugin-deployer-handler-impl.ts:278

getDeployedBackendPluginIds

getDeployedBackendPluginIds(): Promise<`${string}.${string}@${string}`[]>
Returns Promise<`${string}.${string}@${string}`[]>
- Defined in packages/plugin-ext/src/hosted/node/plugin-deployer-handler-impl.ts:71

getDeployedBackendPlugins

getDeployedBackendPlugins(): Promise<DeployedPlugin[]>
Returns Promise<DeployedPlugin[]>
- Defined in packages/plugin-ext/src/hosted/node/plugin-deployer-handler-impl.ts:78

getDeployedFrontendPluginIds

getDeployedFrontendPluginIds(): Promise<`${string}.${string}@${string}`[]>
Returns Promise<`${string}.${string}@${string}`[]>
- Defined in packages/plugin-ext/src/hosted/node/plugin-deployer-handler-impl.ts:64

getDeployedPlugin

getDeployedPlugin(pluginId): undefined | DeployedPlugin
Parameters
- pluginId: `${string}.${string}@${string}`
Returns undefined | DeployedPlugin
Implementation of PluginDeployerHandler.getDeployedPlugin
- Defined in packages/plugin-ext/src/hosted/node/plugin-deployer-handler-impl.ts:109

getDeployedPluginIds

getDeployedPluginIds(): Promise<readonly `${string}.${string}@${string}`[]>
Returns Promise<readonly `${string}.${string}@${string}`[]>
Implementation of PluginDeployerHandler.getDeployedPluginIds
- Defined in packages/plugin-ext/src/hosted/node/plugin-deployer-handler-impl.ts:85

getDeployedPlugins

getDeployedPlugins(): Promise<DeployedPlugin[]>
Returns Promise<DeployedPlugin[]>
Implementation of PluginDeployerHandler.getDeployedPlugins
- Defined in packages/plugin-ext/src/hosted/node/plugin-deployer-handler-impl.ts:89

getDeployedPluginsById

getDeployedPluginsById(pluginId): DeployedPlugin[]
Parameters
- pluginId: string
Returns DeployedPlugin[]
Implementation of PluginDeployerHandler.getDeployedPluginsById
- Defined in packages/plugin-ext/src/hosted/node/plugin-deployer-handler-impl.ts:95

getPluginDependencies

getPluginDependencies(entry): Promise<undefined | PluginDependencies>
Parameters
- entry: PluginDeployerEntry
Returns Promise<undefined | PluginDependencies>
Throws
never! in order to isolate plugin deployment
Implementation of PluginDeployerHandler.getPluginDependencies
- Defined in packages/plugin-ext/src/hosted/node/plugin-deployer-handler-impl.ts:116

`Protected` markAsInstalled

markAsInstalled(id): void
Parameters
- id: `${string}.${string}@${string}`
Returns void
- Defined in packages/plugin-ext/src/hosted/node/plugin-deployer-handler-impl.ts:225

`Protected` setSourceLocationsForPlugin

setSourceLocationsForPlugin(id, entry): void
Parameters
- id: `${string}.${string}@${string}`
- entry: PluginDeployerEntry
Returns void
- Defined in packages/plugin-ext/src/hosted/node/plugin-deployer-handler-impl.ts:268

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>
Implementation of PluginDeployerHandler.undeployPlugin
- Defined in packages/plugin-ext/src/hosted/node/plugin-deployer-handler-impl.ts:245

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>
Implementation of PluginDeployerHandler.uninstallPlugin
- Defined in packages/plugin-ext/src/hosted/node/plugin-deployer-handler-impl.ts:207

Class PluginDeployerHandlerImpl

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns PluginDeployerHandlerImpl

Properties

Private backendPluginsMetadataDeferred

Private Readonly deployedBackendPlugins

Private Readonly deployedFrontendPlugins

Private Readonly deployedLocations

Private frontendPluginsMetadataDeferred

Private Readonly localizationService

Protected Readonly logger

Private Readonly reader

Protected Readonly sourceLocations

Protected Readonly stopwatch

Protected Readonly uninstallationManager

Methods

deployBackendPlugins

Parameters

Returns Promise<number>

deployFrontendPlugins

Parameters

Returns Promise<number>

Protected deployPlugin

Parameters

Returns Promise<boolean>

Throws

disablePlugin

Parameters

Returns Promise<boolean>

enablePlugin

Parameters

Returns Promise<boolean>

getDeployedBackendPluginIds

Returns Promise<`${string}.${string}@${string}`[]>

getDeployedBackendPlugins

Returns Promise<DeployedPlugin[]>

getDeployedFrontendPluginIds

Returns Promise<`${string}.${string}@${string}`[]>

getDeployedPlugin

Parameters

Returns undefined | DeployedPlugin

getDeployedPluginIds

Returns Promise<readonly `${string}.${string}@${string}`[]>

getDeployedPlugins

Returns Promise<DeployedPlugin[]>

getDeployedPluginsById

Parameters

Returns DeployedPlugin[]

getPluginDependencies

Parameters

Returns Promise<undefined | PluginDependencies>

Throws

Protected markAsInstalled

Parameters

Returns void

Protected setSourceLocationsForPlugin

Parameters

Returns void

undeployPlugin

Parameters

Returns Promise<boolean>

uninstallPlugin

Parameters

Returns Promise<boolean>

Settings

Member Visibility

Theme

On This Page

`Private` backendPluginsMetadataDeferred

`Private` `Readonly` deployedBackendPlugins

`Private` `Readonly` deployedFrontendPlugins

`Private` `Readonly` deployedLocations

`Private` frontendPluginsMetadataDeferred

`Private` `Readonly` localizationService

`Protected` `Readonly` logger

`Private` `Readonly` reader

`Protected` `Readonly` sourceLocations

`Protected` `Readonly` stopwatch

`Protected` `Readonly` uninstallationManager

`Protected` deployPlugin

`Protected` markAsInstalled

`Protected` setSourceLocationsForPlugin