Skip to content

RequireThirdPartyPluginApiParams<TApi>

Parameters for requireThirdPartyPluginApi.

Import:

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

Signature:

export interface RequireThirdPartyPluginApiParams<TApi extends object> extends Except<RequirePluginParams, 'app' | 'isPlugin' | 'minPluginVersion' | 'pluginId' | 'pluginName'>, GetThirdPartyPluginApiParams<TApi>

Extends: Except<RequirePluginParams, ‘app’ | ‘isPlugin’ | ‘minPluginVersion’ | ‘pluginId’ | ‘pluginName’>, GetThirdPartyPluginApiParams<TApi>

Properties

PropertyTypeDescription
adapterThirdPartyPluginAdapter<TApi>The adapter of the plugin.
(Inherited from GetThirdPartyPluginApiParams)
appAppThe Obsidian app instance.
(Inherited from GetThirdPartyPluginApiParams)
minPluginVersion?stringThe oldest release the caller works with. Defaults to the adapter's own ThirdPartyPluginAdapter.minPluginVersion.
(Inherited from GetThirdPartyPluginApiParams)

Links to this page: