Interface PluginInstaller

Transfers plugins between PluginRepository instances.

A PluginInstaller is decoupled from both the source and target repositories, allowing different backing mechanisms (HTTP fetch, subprocess package manager, etc.) to be composed freely.

interface PluginInstaller {
    install(
        descriptor: Readonly<PluginDescriptor>,
        source: PluginRepository,
        target: PluginRepository,
    ): Promise<void>;
    uninstall(pluginId: string, target: PluginRepository): Promise<void>;
}

Index

Methods

install uninstall

Methods

install

install(
    descriptor: Readonly<PluginDescriptor>,
    source: PluginRepository,
    target: PluginRepository,
): Promise<void>
Install a plugin from a source repository into a target repository.
Parameters
- descriptor: Readonly<PluginDescriptor>
  the PluginDescriptor identifying the plugin to install.
- source: PluginRepository
  the PluginRepository from which to obtain the plugin.
- target: PluginRepository
  the PluginRepository into which to install the plugin.
Returns Promise<void>
- Defined in api/plugin_installer/PluginInstaller.ts:18

uninstall

uninstall(pluginId: string, target: PluginRepository): Promise<void>
Remove a plugin from a repository.
Parameters
- pluginId: string
  the ID of the plugin to remove.
- target: PluginRepository
  the PluginRepository from which to remove the plugin.
Returns Promise<void>
- Defined in api/plugin_installer/PluginInstaller.ts:30

Interface PluginInstaller

Index

Methods

Methods

install

Parameters

Returns Promise<void>

uninstall

Parameters

Returns Promise<void>

Settings

On This Page