Skip to content

PluginAvailability

Whether another plugin’s instance can be used right now, and if not, why.

Import:

import type { PluginAvailability } from '@mnaoumov/obsidian-lib/plugin/plugin-instance';

Signature:

export enum PluginAvailability

Members:

Member Value Description
Available 'available' Loaded, onload settled, and every declared requirement met.
InvalidVersion 'invalidVersion' Running at a release whose manifest.version cannot be parsed, while the caller declared a GetPluginAvailabilityParams.minPluginVersion. Counts as unavailable, because failing closed is the safe direction.
Loading 'loading' The instance exists but its onload has not settled yet.
NotEnabled 'notEnabled' Installed but neither enabled nor running.
NotInstalled 'notInstalled' Not installed in this vault.
NotLoaded 'notLoaded' Installed and enabled in the configuration, but no instance is running. At startup that is a plugin Obsidian has not reached yet; later it is one that failed to load, or one switched off by a disable that does not touch the configuration.
Outdated 'outdated' Running at a release older than the caller’s GetPluginAvailabilityParams.minPluginVersion.
ShapeMismatch 'shapeMismatch' Running, but the caller’s GetPluginAvailabilityParams.isPlugin rejected the instance.

Links to this page: