Plugins

Properties

app

app: App

Reference to App

---

enabledPlugins

enabledPlugins: Set<string>

Set of enabled plugin IDs

Remark

The plugin ids aren’t guaranteed to be either active (in app.plugins.plugins) or installed (in app.plugins.manifests)

---

manifests

manifests: PluginsManifestsRecord

Manifests of all the plugins that are installed

---

plugins

plugins: PluginsPluginsRecord

Mapping of plugin ID to active plugin instance

Remark

Prefer usage of getPlugin to access a plugin

---

requestSaveConfig

requestSaveConfig: Debouncer<[], Promise<void>>

---

updates

updates: Map<string, PluginUpdateManifest>

Mapping of plugin ID to available updates

Methods

checkForUpdates()

checkForUpdates(): Promise<void>

Check for plugin updates

Returns

Promise<void>

---

disablePlugin()

disablePlugin(id): Promise<void>

Unload a plugin by ID

Parameters

• id: string

Returns

Promise<void>

---

disablePluginAndSave()

disablePluginAndSave(id): Promise<void>

Unload a plugin by ID and save config for persistence

Parameters

• id: string

Returns

Promise<void>

---

enablePlugin()

enablePlugin(id): Promise<void>

Enable a plugin by ID

Parameters

• id: string

Returns

Promise<void>

---

enablePluginAndSave()

enablePluginAndSave(id): Promise<void>

Enable a plugin by ID and save config for persistence

Parameters

• id: string

Returns

Promise<void>

---

getPlugin()

getPlugin(id): null | Plugin

Get a plugin by ID

Parameters

• id: string

Returns

null | Plugin

---

getPluginFolder()

getPluginFolder(): string

Get the folder where plugins are stored

Returns

string

---

installPlugin()

installPlugin(repo, version, manifest): Promise<void>

Install a plugin from a given URL

Parameters

• repo: string

• version: string

• manifest: PluginManifest

Returns

Promise<void>

---

isDeprecated()

isDeprecated(id): boolean

Check whether a plugin is deprecated

Parameters

• id: string

Returns

boolean

---

isEnabled()

isEnabled(): boolean

Check whether community plugins are enabled

Returns

boolean

---

loadManifest()

loadManifest(path): Promise<void>

Load a specific plugin’s manifest by its folder path

Parameters

• path: string

Returns

Promise<void>

---

loadPlugin()

loadPlugin(id): Promise<Plugin>

Load a plugin by its ID

Parameters

• id: string

Returns

Promise<Plugin>

---

uninstallPlugin()

uninstallPlugin(id): Promise<void>

Uninstall a plugin by ID

Parameters

• id: string

Returns

Promise<void>

---

unloadPlugin()

unloadPlugin(id): Promise<void>

Unload a plugin by ID

Parameters

• id: string

Returns

Promise<void>