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. A plain string rather than obsidian-typings' ConfigItem, because obsidian-typings is only a development dependency of this package, so its types cannot appear in the published declarations, and because Obsidian itself accepts any key.
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