RequirePluginParams<TPlugin>
Parameters for requirePlugin.
Import:
import type { RequirePluginParams } from '@mnaoumov/obsidian-lib/plugin/plugin-instance';Signature:
export interface RequirePluginParams<TPlugin extends Plugin = Plugin> extends GetPluginAvailabilityParams<TPlugin>Extends: GetPluginAvailabilityParams<TPlugin>
Properties
| Property | Type | Description |
|---|---|---|
| abortSignal? | AbortSignal | Ends the wait early; the promise rejects with the signal's reason. |
| app | App | The Obsidian app instance. (Inherited from GetPluginAvailabilityParams) |
| component | Component | The component owning the wait and its notice. Its unload ends both, rejecting the promise. |
| isPlugin? | (plugin: Plugin) => plugin is TPlugin | Verifies that the running instance is the shape the caller uses. Without it, TPlugin is an assertion nothing checks.(Inherited from GetPluginAvailabilityParams) |
| minPluginVersion? | string | The oldest release of the plugin the caller works with, compared with its manifest.version. This is a plugin RELEASE, never an API contract version: a provider publishing a versioned contract is reached through watchPluginApi's apiVersionRange instead.(Inherited from GetPluginAvailabilityParams) |
| pluginId | string | The manifest.id of the plugin.(Inherited from GetPluginAvailabilityParams) |
| pluginName | string | The display name of the required plugin, shown to the user. |
| pluginNoticeComponent | PluginNoticeComponent | The asking plugin's notice component, which shows what is missing and the button that fixes it. |
| requestingPluginName | string | The display name of the asking plugin, named in the notice. |
| timeoutInMilliseconds? | number | How long to wait before giving up. By default the wait lasts until the user repairs the plugin, the RequirePluginParams.abortSignal aborts or the RequirePluginParams.component unloads. |
Links to this page: