WithAppConfigParams<T>

Parameters for withAppConfig.

Import:

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

Signature:

export interface WithAppConfigParams<T> extends SetAppConfigParams

Extends: SetAppConfigParams

Properties

Property	Type	Description
callback	(this: void) => Promise<T>	The work to run while the key holds SetAppConfigParams.value.
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. (Inherited from SetAppConfigParams)
transport?	ObsidianTransport	Override the transport. When omitted, the transport the current test context is driving is used. (Inherited from SetAppConfigParams)
value	unknown	The value to write. undefined deletes the key, leaving Obsidian's own default in force. (Inherited from SetAppConfigParams)
vaultPath?	string	The vault whose Obsidian instance to read or write. When omitted, the current test context's vault is used. (Inherited from SetAppConfigParams)

---

Links to this page:

• withAppConfig