Skip to content

requireThirdPartyPluginApi<TApi>

Waits for a third-party plugin’s API, asking the user to install, enable or update the plugin while it is not available. Settles once; see requirePlugin.

Import:

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

Signature:

function requireThirdPartyPluginApi(params: RequireThirdPartyPluginApiParams<TApi>): Promise<TApi>

Parameters:

Parameter Type Description
params RequireThirdPartyPluginApiParams<TApi> The RequireThirdPartyPluginApiParams.

Returns: Promise<TApi> — A Promise resolving with the API.


Links to this page: