Skip to content

PluginApiUnavailableErrorConstructorParams

Parameters for the PluginApiUnavailableError constructor.

Import:

import type { PluginApiUnavailableErrorConstructorParams } from 'obsidian-dev-utils/obsidian/plugin/plugin-api';

Signature:

export interface PluginApiUnavailableErrorConstructorParams

Properties

PropertyTypeDescription
message?stringAn explicit message. When omitted, one is derived from the plugin id and the reason.
pluginIdstringThe manifest.id of the plugin whose API was requested.
reasonPluginApiUnavailabilityReasonWhich of the five failures occurred.