Skip to content

OwnedInstanceConfig

Configuration for a harness-owned, isolated Obsidian instance.

When present, the transport launches and owns its own Obsidian process against an isolated user-data directory instead of attaching to a running instance.

Import:

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

Signature:

export interface OwnedInstanceConfig

Properties

PropertyTypeDescription
asar?OwnedInstanceAsar | undefinedOptional asar to provision into userDataDirectory before launch.
compatibility?InstallerCompatibility | undefinedThe resolved installer↔app compatibility verdict, when it could be determined (an asar-swap onto a known shell version). Surfaced by DesktopCdpTransport.getCompatibility. An 'unrunnable' verdict reaches this surface only when the proactive throw is disabled (shouldThrowOnIncompatibleInstaller: false); otherwise it throws IncompatibleInstallerVersionError before the config is built.
exePathstringAbsolute path to the Obsidian shell executable to launch.
userDataDirectorystringAbsolute path to the isolated user-data directory. Created and owned by the transport, and deleted on dispose.

Links to this page: