Skip to content

getThirdPartyPluginAvailability<TApi>

Reads whether a third-party plugin’s API can be used right now, and if not, why.

Import:

import { getThirdPartyPluginAvailability } from '@mnaoumov/obsidian-lib/plugin/third-party-plugin';

Signature:

function getThirdPartyPluginAvailability(params: GetThirdPartyPluginAvailabilityParams<TApi>): PluginAvailability

Parameters:

Parameter Type Description
params GetThirdPartyPluginAvailabilityParams<TApi> The GetThirdPartyPluginApiParams.

Returns: PluginAvailability — The PluginAvailability; PluginAvailability.ShapeMismatch when the adapter does not recognize the running instance.


Links to this page: