agent-sdk / Exports / BundlePluginInstaller
Class: BundlePluginInstaller
Installs, uninstalls, enables, and disables bundle plugins.
Table of contents
Constructors
Methods
Constructors
constructor
• new BundlePluginInstaller(options): BundlePluginInstaller
Parameters
| Name | Type |
|---|---|
options | IBundlePluginInstallerOptions |
Returns
Defined in
agent-sdk/src/plugins/bundle-plugin-installer.ts:53
Methods
install
▸ install(pluginName, marketplaceName): Promise<void>
Install a plugin from a marketplace.
- Read marketplace manifest to find the plugin entry.
- Resolve source (relative path, github, or url).
- Copy/clone to
cache/<marketplace>/<plugin>/<version>/. - Record in
installed_plugins.json.
Parameters
| Name | Type |
|---|---|
pluginName | string |
marketplaceName | string |
Returns
Promise<void>
Defined in
agent-sdk/src/plugins/bundle-plugin-installer.ts:70
uninstall
▸ uninstall(pluginId): Promise<void>
Uninstall a plugin. Removes from cache and from installed_plugins.json.
Parameters
| Name | Type |
|---|---|
pluginId | string |
Returns
Promise<void>
Defined in
agent-sdk/src/plugins/bundle-plugin-installer.ts:110
enable
▸ enable(pluginId): Promise<void>
Enable a plugin by setting its enabledPlugins entry to true.
Parameters
| Name | Type |
|---|---|
pluginId | string |
Returns
Promise<void>
Defined in
agent-sdk/src/plugins/bundle-plugin-installer.ts:132
disable
▸ disable(pluginId): Promise<void>
Disable a plugin by setting its enabledPlugins entry to false.
Parameters
| Name | Type |
|---|---|
pluginId | string |
Returns
Promise<void>
Defined in
agent-sdk/src/plugins/bundle-plugin-installer.ts:137
getInstalledPlugins
▸ getInstalledPlugins(): IInstalledPluginsRegistry
Get all installed plugins.
Returns
Defined in
agent-sdk/src/plugins/bundle-plugin-installer.ts:142
getPluginsByMarketplace
▸ getPluginsByMarketplace(marketplaceName): IInstalledPluginRecord[]
Get plugins installed from a specific marketplace.
Parameters
| Name | Type |
|---|---|
marketplaceName | string |