Skip to content

installConfigureEnableCommunityPlugin

Installs a community plugin, writes its settings, THEN enables it — in that order — so the plugin loads already configured (a plugin enabled before it is configured runs its onload with default settings and does nothing useful). If the plugin is already enabled and the settings changed, it is disabled and re-enabled so the new settings take effect. settings is optional: omit it for a plugin that needs no configuration. Composes installCommunityPlugin, configureCommunityPlugin, enableCommunityPlugin and disableCommunityPlugin.

Import:

import { installConfigureEnableCommunityPlugin } from 'obsidian-dev-utils/obsidian/community-plugins';

Signature:

function installConfigureEnableCommunityPlugin(params: InstallConfigureEnableCommunityPluginParams): Promise<void>

Parameters:

ParameterTypeDescription
paramsInstallConfigureEnableCommunityPluginParamsThe InstallConfigureEnableCommunityPluginParams.

Returns: Promise<void> — A Promise that resolves once the plugin is installed, configured and enabled.


Links to this page: