Class ConfigError

constructor

• new ConfigError(options: ConfigErrorOptions): ConfigError

  Creates a new ConfigError instance.

  Parameters

  • options: ConfigErrorOptions

    Config error construction options including validation errors and config path.

  Returns ConfigError

  Example

  import { ConfigError } from '#core/errors/config-error.js';
  
  const error = new ConfigError({
    message: 'Config file contains invalid values',
    attempted: 'Load config from praman.config.ts',
    configPath: '/app/praman.config.ts',
    validationErrors: [{ path: ['auth'], message: 'Required', code: 'invalid_type' }],
  });
  Copy

ReadonlyconfigPath

ReadonlyvalidationErrors

toAIContext

• toAIContext(): AIErrorContext & {
      configPath: string
      | undefined;
      validationErrors: readonly ValidationIssue[];
  }

  Returns structured context for AI agents with configuration diagnostics.

  Returns AIErrorContext & {
      configPath: string | undefined;
      validationErrors: readonly ValidationIssue[];
  }

  Base AI context plus validationErrors and configPath fields to help diagnose configuration issues and suggest fixes.

  Example

  const context = error.toAIContext();
  // context.validationErrors, context.configPath available
  // Send to LLM for config fix suggestions
  Copy

toJSON

• toJSON(): SerializedPramanError & {
      configPath: string
      | undefined;
      validationErrors: readonly ValidationIssue[];
  }

  Serializes the error to a JSON-safe object with configuration fields.

  Returns SerializedPramanError & {
      configPath: string | undefined;
      validationErrors: readonly ValidationIssue[];
  }

  Base fields plus validationErrors and configPath.

  Example

  const json = error.toJSON();
  // json.configPath === '/app/praman.config.ts'
  // json.validationErrors === [{ path: ['auth'], message: 'Required', code: 'invalid_type' }]
  Copy