GetAppConfigParams

Parameters for getAppConfig, and the shared shape of the writers below.

Import:

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

Signature:

export interface 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.
transport?	ObsidianTransport	Override the transport. When omitted, the transport the current test context is driving is used.
vaultPath?	string	The vault whose Obsidian instance to read or write. When omitted, the current test context's vault is used.

---

Links to this page:

• getAppConfig
• SetAppConfigParams