RegisterDemoVaultButtonSuiteOptions

The options for registerDemoVaultButtonSuite.

Import:

import type { RegisterDemoVaultButtonSuiteOptions } from '@mnaoumov/obsidian-dev-toolkit/demo-vault-buttons';

Signature:

export interface RegisterDemoVaultButtonSuiteOptions

Properties

Property	Type	Description
buttonResultTimeoutInMilliseconds?	number	How long, in milliseconds, to wait for a clicked button to report a result. Bounded by the same sum as RegisterDemoVaultButtonSuiteOptions.settleTimeoutInMilliseconds, and refused by the same throw at registration.
excludedFolders?	readonly string[]	Folders to skip whole, matched against both the folder name and its path relative to the demo vault root — for a group whose notes cannot run unattended, such as ones that first install a third-party plugin from the community store.
excludedNotes?	readonly string[]	Note file names (relative to the demo vault root) to skip.
expectedNonOkButtons?	readonly ExpectedNonOkButton[]	Buttons that legitimately do not report success: an error demo, or a button that turns system messages off and so never prints the result line the suite classifies.
rootFolder?	string	The repository root holding demo-vault/.
settleTimeoutInMilliseconds?	number	How long, in milliseconds, to wait for a note's preview and its buttons to mount. Together with buttonResultTimeoutInMilliseconds this must stay under the transport's ~30 s script timeout: one button click spends both inside a SINGLE evaluation, so a sum at or over the cap cannot be honoured and turns a real timeout into a bare script timeout naming only the transport. registerDemoVaultButtonSuite throws on such a pair rather than registering it.
shouldDismissModals?	boolean	Whether to dismiss any open modal while waiting for a clicked button's result, and again once it is classified. A button that awaits an alert / confirm / prompt cannot report a result until somebody closes the dialog, so without this it ends as timeout — and the dialog it left open then sits over every later button in the run. Off by default, so no suite changes behavior unasked.

---

Links to this page:

• registerDemoVaultButtonSuite