Class PluginError

constructor

• new PluginError(options: PluginErrorOptions): PluginError

  Creates a new PluginError instance.

  Parameters

  • options: PluginErrorOptions

    Plugin error construction options including the required plugin name and optional version for diagnostic context.

  Returns PluginError

  Example

  import { PluginError } from '#core/errors/plugin-error.js';
  
  const error = new PluginError({
    message: 'Plugin incompatible with Praman v1.0',
    attempted: 'Load plugin my-custom-auth',
    pluginName: 'my-custom-auth',
    pluginVersion: '0.5.0',
    code: 'ERR_PLUGIN_INCOMPATIBLE',
  });
  Copy

ReadonlypluginName

ReadonlypluginVersion

toAIContext

• toAIContext(): AIErrorContext & {
      pluginName: string;
      pluginVersion: string
      | undefined;
  }

  Returns AI-agent-friendly context with plugin-specific diagnostic fields.

  Returns AIErrorContext & { pluginName: string; pluginVersion: string | undefined }

  Base AI context extended with plugin name and version details.

  Example

  const ctx = error.toAIContext();
  // LLM can use ctx.pluginName to locate the plugin package
  // and ctx.pluginVersion to check compatibility requirements
  Copy

toJSON

• toJSON(): SerializedPramanError & {
      pluginName: string;
      pluginVersion: string
      | undefined;
  }

  Serializes this error to a JSON-safe object with plugin-specific fields.

  Returns SerializedPramanError & {
      pluginName: string;
      pluginVersion: string | undefined;
  }

  Base serialization extended with pluginName and pluginVersion.

  Example

  const json = error.toJSON();
  console.log(json.pluginName);    // 'my-custom-auth'
  console.log(json.pluginVersion); // '0.5.0'
  Copy