SetAppConfigParams

Parameters for setAppConfig.

Import:

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

Signature:

export interface SetAppConfigParams extends GetAppConfigParams

Extends: GetAppConfigParams

Properties

Property	Type	Description
configKey	string	The vault config key, e.g. settingsPopoutWindow. Not narrowed to obsidian-typings' ConfigItem: that union omits keys Obsidian really reads, settingsPopoutWindow among them, which is the whole reason a consumer had to widen the setter by hand. (Inherited from GetAppConfigParams)
transport?	ObsidianTransport	Override the transport. When omitted, the transport the current test context is driving is used. (Inherited from GetAppConfigParams)
value	unknown	The value to write. undefined deletes the key, leaving Obsidian's own default in force.
vaultPath?	string	The vault whose Obsidian instance to read or write. When omitted, the current test context's vault is used. (Inherited from GetAppConfigParams)

---

Links to this page:

• setAppConfig
• WithAppConfigParams