Skip to content

getThirdPartyPluginApi<TApi>

Returns a third-party plugin’s typed API when the plugin is PluginAvailability.Available, and null otherwise.

Import:

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

Signature:

function getThirdPartyPluginApi(params: GetThirdPartyPluginApiParams<TApi>): TApi | null

Parameters:

Parameter Type Description
params GetThirdPartyPluginApiParams<TApi> The GetThirdPartyPluginApiParams.

Returns: TApi | null — The API, or null.


Links to this page: