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 OwnedInstanceConfigProperties
| Property | Type | Description |
|---|---|---|
| asar? | OwnedInstanceAsar | undefined | Optional asar to provision into userDataDirectory before launch. |
| compatibility? | InstallerCompatibility | undefined | The 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. |
| exePath | string | Absolute path to the Obsidian shell executable to launch. |
| isPersistentUserDataDirectory? | boolean | Whether userDataDirectory is a persistent profile the caller keeps (the persistentUserDataDirectory option): the transport then merges into its obsidian.json instead of overwriting it, holds a lock on it while the instance runs, and never deletes it. |
| userDataDirectory | string | Absolute path to the user-data directory. A temporary one is created and owned by the transport, and deleted on dispose; a persistent one (isPersistentUserDataDirectory) is kept. |
Links to this page: