Skip to content

FindPluginApiParams<TApi>

Parameters for findPluginApi.

Import:

import type { FindPluginApiParams } from '@mnaoumov/obsidian-lib/plugin/plugin-api';

Signature:

export interface FindPluginApiParams<TApi extends object = object>

Properties

PropertyTypeDescription
apiVersionRangestringThe semver range of contract versions the consumer compiled against. The same rules as WatchPluginApiParams.apiVersionRange apply.
contract?ApiContract<TApi>The contract the CONSUMER expects. When supplied, it wins over the provider's published contract, as in WatchPluginApiParams.contract.
pluginIdstringThe manifest.id of the providing plugin.

Links to this page: