Skip to main content
Version: 1.x

Class: ConfigError

Error subclass for configuration failures.

Failure Mode​

Invalid config file — YAML/JSON parse error or Zod schema validation failure

Failure Mode​

Missing config — no praman.config.ts/yml found in project root

Failure Mode​

Schema validation — config values out of range or wrong type

Example​

const error = new ConfigError({
  message: 'Invalid auth strategy',
  attempted: 'Validate config',
  validationErrors: [{ path: ['auth'], message: 'Invalid', code: 'invalid_enum_value' }],
});

Extends​

Constructors​

Constructor​

new ConfigError(options): 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' }],
});

Overrides​

PramanError.constructor

Properties​

attempted​

readonly attempted: string

Inherited from​

PramanError.attempted

cause?​

optional cause?: unknown

Inherited from​

PramanError.cause

code​

readonly code: ErrorCode

Inherited from​

PramanError.code

configPath​

readonly configPath: string | undefined

details​

readonly details: Readonly<Record<string, unknown>>

Inherited from​

PramanError.details

message​

message: string

Inherited from​

PramanError.message

name​

name: string

Inherited from​

PramanError.name

retryable​

readonly retryable: boolean

Inherited from​

PramanError.retryable

severity​

readonly severity: "error" | "info" | "warning"

Inherited from​

PramanError.severity

stack?​

optional stack?: string

Inherited from​

PramanError.stack

suggestions​

readonly suggestions: readonly string[]

Inherited from​

PramanError.suggestions

timestamp​

readonly timestamp: string

Inherited from​

PramanError.timestamp

validationErrors​

readonly validationErrors: readonly ValidationIssue[]

stackTraceLimit​

static stackTraceLimit: number

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from​

PramanError.stackTraceLimit

Methods​

toAIContext()​

toAIContext(): AIErrorContext & object

Returns structured context for AI agents with configuration diagnostics.

Returns​

AIErrorContext & object

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

Overrides​

PramanError.toAIContext

toJSON()​

toJSON(): SerializedPramanError & object

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

Returns​

SerializedPramanError & object

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' }]

Overrides​

PramanError.toJSON

toUserMessage()​

toUserMessage(): string

Formats the error for human-readable console output.

Returns​

string

Multi-line formatted string with all diagnostic sections.

Example​

console.error(error.toUserMessage());

Inherited from​

PramanError.toUserMessage

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters​

targetObject​

object

constructorOpt?​

Function

Returns​

void

Inherited from​

PramanError.captureStackTrace

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Parameters​

err​

Error

stackTraces​

CallSite[]

Returns​

any

See​

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from​

PramanError.prepareStackTrace