Skip to content

WatchThirdPartyPluginApiParams<TApi>

Parameters for watchThirdPartyPluginApi.

Import:

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

Signature:

export interface WatchThirdPartyPluginApiParams<TApi extends object> extends GetThirdPartyPluginApiParams<TApi>

Extends: GetThirdPartyPluginApiParams<TApi>

Properties

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

Links to this page: