Plugins

Defined in: src/obsidian/internals/Plugins/Plugins.d.ts:12

Properties

app

app: App

Defined in: src/obsidian/internals/Plugins/Plugins.d.ts:16

Reference to App

---

enabledPlugins

enabledPlugins: Set<string>

Defined in: src/obsidian/internals/Plugins/Plugins.d.ts:22

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

Defined in: src/obsidian/internals/Plugins/Plugins.d.ts:28

Manifests of all the plugins that are installed

---

plugins

plugins: PluginsPluginsRecord

Defined in: src/obsidian/internals/Plugins/Plugins.d.ts:34

Mapping of plugin ID to active plugin instance

Remark

Prefer usage of getPlugin to access a plugin

---

requestSaveConfig

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

Defined in: src/obsidian/internals/Plugins/Plugins.d.ts:35

---

updates

updates: Map<string, PluginUpdateManifest>

Defined in: src/obsidian/internals/Plugins/Plugins.d.ts:39

Mapping of plugin ID to available updates

Methods

checkForUpdates()

checkForUpdates(): Promise<void>

Defined in: src/obsidian/internals/Plugins/Plugins.d.ts:46

Check for plugin updates

Returns

Promise<void>

---

disablePlugin()

disablePlugin(id): Promise<void>

Defined in: src/obsidian/internals/Plugins/Plugins.d.ts:50

Unload a plugin by ID

Parameters

id

string

Returns

Promise<void>

---

disablePluginAndSave()

disablePluginAndSave(id): Promise<void>

Defined in: src/obsidian/internals/Plugins/Plugins.d.ts:54

Unload a plugin by ID and save config for persistence

Parameters

id

string

Returns

Promise<void>

---

enablePlugin()

enablePlugin(id): Promise<void>

Defined in: src/obsidian/internals/Plugins/Plugins.d.ts:58

Enable a plugin by ID

Parameters

id

string

Returns

Promise<void>

---

enablePluginAndSave()

enablePluginAndSave(id): Promise<void>

Defined in: src/obsidian/internals/Plugins/Plugins.d.ts:62

Enable a plugin by ID and save config for persistence

Parameters

id

string

Returns

Promise<void>

---

getPlugin()

getPlugin(id): null | Plugin

Defined in: src/obsidian/internals/Plugins/Plugins.d.ts:66

Get a plugin by ID

Parameters

id

string

Returns

null | Plugin

---

getPluginFolder()

getPluginFolder(): string

Defined in: src/obsidian/internals/Plugins/Plugins.d.ts:70

Get the folder where plugins are stored

Returns

string

---

installPlugin()

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

Defined in: src/obsidian/internals/Plugins/Plugins.d.ts:76

Install a plugin from a given URL

Parameters

repo

string

version

string

manifest

PluginManifest

Returns

Promise<void>

---

isDeprecated()

isDeprecated(id): boolean

Defined in: src/obsidian/internals/Plugins/Plugins.d.ts:80

Check whether a plugin is deprecated

Parameters

id

string

Returns

boolean

---

isEnabled()

isEnabled(): boolean

Defined in: src/obsidian/internals/Plugins/Plugins.d.ts:84

Check whether community plugins are enabled

Returns

boolean

---

loadManifest()

loadManifest(path): Promise<void>

Defined in: src/obsidian/internals/Plugins/Plugins.d.ts:88

Load a specific plugin’s manifest by its folder path

Parameters

path

string

Returns

Promise<void>

---

loadPlugin()

loadPlugin(id): Promise<Plugin>

Defined in: src/obsidian/internals/Plugins/Plugins.d.ts:94

Load a plugin by its ID

Parameters

id

string

Returns

Promise<Plugin>

---

uninstallPlugin()

uninstallPlugin(id): Promise<void>

Defined in: src/obsidian/internals/Plugins/Plugins.d.ts:104

Uninstall a plugin by ID

Parameters

id

string

Returns

Promise<void>

---

unloadPlugin()

unloadPlugin(id): Promise<void>

Defined in: src/obsidian/internals/Plugins/Plugins.d.ts:108

Unload a plugin by ID

Parameters

id

string

Returns

Promise<void>