Skip to content

ReloadPluginParams

Parameters for reloadPlugin.

Import:

import type { ReloadPluginParams } from 'obsidian-integration-testing';

Signature:

export interface ReloadPluginParams extends PluginLifecycleTarget

Extends: PluginLifecycleTarget

Properties

PropertyTypeDescription
dataJsonText?stringText to write as the plugin's data.json while it is disabled, verbatim: JSON.stringify(settings) for given settings, or text that is not JSON for a corrupt file. When omitted, the file is left as it is.
pluginIdstringThe id of the plugin to act on. Its files must be in the vault's plugins folder.
(Inherited from PluginLifecycleTarget)
shouldRemoveDataJson?booleanWhether to delete the plugin's data.json while it is disabled, so it loads as on a fresh install.
transport?ObsidianTransportOverride the transport. When omitted, the transport the current test context is driving is used.
(Inherited from PluginLifecycleTarget)
vaultPath?stringThe vault whose Obsidian instance to act in. When omitted, the current test context's vault is used.
(Inherited from PluginLifecycleTarget)

Links to this page: