Skip to content

GetPluginAvailabilityParams<TPlugin>

Parameters for getPluginAvailability.

Import:

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

Signature:

export interface GetPluginAvailabilityParams<TPlugin extends Plugin = Plugin>

Properties

PropertyTypeDescription
appAppThe Obsidian app instance.
isPlugin?(plugin: Plugin) => plugin is TPluginVerifies that the running instance is the shape the caller uses. Without it, TPlugin is an assertion nothing checks.
minPluginVersion?stringThe oldest release of the plugin the caller works with, compared with its manifest.version. This is a plugin RELEASE, never an API contract version: a provider publishing a versioned contract is reached through watchPluginApi's apiVersionRange instead.
pluginIdstringThe manifest.id of the plugin.

Links to this page: