Skip to content

InstallerCompatibility

The compatibility verdict for a resolved (app, installer) version pair, carried as data on the transport / connection result so consumers can assert on it.

Import:

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

Signature:

export interface InstallerCompatibility

Properties

PropertyTypeDescription
appVersionstringThe resolved Obsidian app (asar) version.
installerVersionnull | stringThe resolved installer/Electron shell version, or null when unknown.
message?stringA human-readable explanation, present for the 'nagged' tier.
minRecommendedInstallerVersion?stringThe recommended installer floor, when the table carries one.
minRunnableInstallerVersion?stringThe run floor, when the table carries one.
tierInstallerCompatibilityTierThe resolved compatibility tier.

Links to this page: