Class ConfigError

Error subclass for configuration failures.

Example

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

Hierarchy (View Summary)

PramanError
- ConfigError

Index

Constructors

constructor

new ConfigError(options: ConfigErrorOptions): ConfigError
Parameters
- options: ConfigErrorOptions
Returns ConfigError
Overrides PramanError.constructor
- Defined in core/errors/config-error.ts:61

Properties

`Readonly`attempted

attempted: string

`Readonly`code

code: ErrorCode

`Readonly`configPath

configPath: string | undefined

`Readonly`details

details: Readonly<Record<string, unknown>>

`Readonly`retryable

retryable: boolean

`Readonly`severity

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

`Readonly`suggestions

suggestions: readonly string[]

`Readonly`timestamp

timestamp: string

`Readonly`validationErrors

validationErrors: readonly ValidationIssue[]

Methods

toAIContext

toAIContext(): AIErrorContext & {
    configPath: string
    | undefined;
    validationErrors: readonly ValidationIssue[];
}
Returns structured context for AI agents to reason about the error.

Returns AIErrorContext & {
configPath: string | undefined;
validationErrors: readonly ValidationIssue[];
}
AI-friendly context object.
Remarks
Same as toJSON() but omits stack and name — AI agents don't need stack traces, and the error type is conveyed by code.
Example
```
const context = error.toAIContext();
// Send to LLM for self-healing analysis
```
Overrides PramanError.toAIContext
- Defined in core/errors/config-error.ts:87

toJSON

toJSON(): SerializedPramanError & {
    configPath: string
    | undefined;
    validationErrors: readonly ValidationIssue[];
}
Serializes the error to a plain JSON-safe object.

Returns SerializedPramanError & {
configPath: string | undefined;
validationErrors: readonly ValidationIssue[];
}
Structured representation with all diagnostic fields.
Example
```
const json = error.toJSON();
logger.debug(JSON.stringify(json, null, 2));
```
Overrides PramanError.toJSON
- Defined in core/errors/config-error.ts:76

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
- Defined in core/errors/base.ts:171

Class ConfigError

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ConfigError

Properties

`Readonly`attempted

`Readonly`code

`Readonly`configPath

`Readonly`details

`Readonly`retryable

`Readonly`severity

`Readonly`suggestions

`Readonly`timestamp

`Readonly`validationErrors

Methods

toAIContext

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

Remarks

Example

toJSON

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

Example

toUserMessage

Returns string

Example

Settings

On This Page

Class ConfigError

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ConfigError

Properties

Readonlyattempted

Readonlycode

ReadonlyconfigPath

Readonlydetails

Readonlyretryable

Readonlyseverity

Readonlysuggestions

Readonlytimestamp

ReadonlyvalidationErrors

Methods

toAIContext

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

Remarks

Example

toJSON

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

Example

toUserMessage

Returns string

Example

Settings

On This Page

`Readonly`attempted

`Readonly`code

`Readonly`configPath

`Readonly`details

`Readonly`retryable

`Readonly`severity

`Readonly`suggestions

`Readonly`timestamp

`Readonly`validationErrors

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

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