ThirdPartyPluginApiRef<TApi>
A live reference to a third-party plugin’s API.
Import:
import type { ThirdPartyPluginApiRef } from '@mnaoumov/obsidian-lib/plugin/third-party-plugin';Signature:
export interface ThirdPartyPluginApiRef<TApi extends object> extends AsyncEventSource<ThirdPartyPluginApiRefEventMap>Extends: AsyncEventSource<ThirdPartyPluginApiRefEventMap>
Properties
| Property | Type | Description |
|---|---|---|
| availability | PluginAvailability | Whether the API can be used right now, and if not, why. Read at the moment of reading. |
| value | null | TApi | The API, or null when it is not available right now. null during the consumer's onload may only mean the plugin has not loaded yet; the value becomes the API on its own once it has. |
Links to this page: