Skip to content

ElectronCompatibility

The runtime Electron compatibility verdict for a booted owned instance, carried as data on the transport / connection result so consumers can assert on it.

Import:

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

Signature:

export interface ElectronCompatibility

Properties

PropertyTypeDescription
actualElectronVersionnull | stringThe Electron version the instance is actually running, or null when unreadable.
appVersionstringThe resolved Obsidian app (asar) version that is running.
message?stringA human-readable explanation, present for the 'nagged' tier.
minRecommendedElectronVersion?stringThe app's recommended-minimum Electron version, when the table carries one.
tierElectronCompatibilityTierThe resolved compatibility tier.

Links to this page: