PluginApiValidationError

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

Only ever thrown while the obsidian-dev-utils:PluginApi debugger is enabled — in production the methods are not wrapped at all.

Import:

import { PluginApiValidationError } from 'obsidian-dev-utils/obsidian/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:

• PluginApiValidationErrorConstructorParams