PluginApiValidationError

Thrown when a published API’s payload fails the schema its contract declares.

Only ever thrown while the obsidian-lib:validate-plugin-api-payloads debug switch is on (see getValidatePluginApiPayloadsDebugSwitch) — otherwise no payload is validated at all.

Import:

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

Signature:

export class PluginApiValidationError extends Error

Extends: Error

Constructor

new PluginApiValidationError(params: PluginApiValidationErrorConstructorParams)

Creates a PluginApiValidationError.

Properties

Property	Type	Description
issues	readonly StandardSchemaV1.Issue[]	The issues the schema reported.
methodName	string	The name of the method whose payload failed validation.
pluginId	string	The manifest.id of the providing plugin.

---

Links to this page:

• getValidatePluginApiPayloadsDebugSwitch
• PluginApiValidationErrorConstructorParams