Skip to main content
Version: 1.x

Class: PramanError

Base error class for all Praman errors.

Remarks​

Extends Error with structured diagnostic fields:

  • code — machine-readable error code from ErrorCode
  • attempted — human description of the operation that failed
  • retryable — whether the caller can retry the operation
  • severity — 'error', 'warning', or 'info'
  • details — structured key-value context
  • suggestions — recovery hints for humans and AI agents
  • timestamp — ISO 8601 creation time

Example​

const error = new PramanError({
  code: 'ERR_CONFIG_INVALID',
  message: 'Invalid config',
  attempted: 'Load config',
  retryable: false,
});
logger.error(error.toUserMessage());

Extends​

  • Error

Extended by​

Constructors​

Constructor​

new PramanError(options): PramanError

Parameters​

options​

PramanErrorOptions

Returns​

PramanError

Overrides​

Error.constructor

Properties​

attempted​

readonly attempted: string

cause?​

optional cause?: unknown

Inherited from​

Error.cause

code​

readonly code: ErrorCode

details​

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

message​

message: string

Inherited from​

Error.message

name​

name: string

Inherited from​

Error.name

retryable​

readonly retryable: boolean

severity​

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

stack?​

optional stack?: string

Inherited from​

Error.stack

suggestions​

readonly suggestions: readonly string[]

timestamp​

readonly timestamp: string

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​

Error.stackTraceLimit

Methods​

toAIContext()​

toAIContext(): AIErrorContext

Returns structured context for AI agents to reason about the error.

Returns​

AIErrorContext

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

toJSON()​

toJSON(): SerializedPramanError

Serializes the error to a plain JSON-safe object.

Returns​

SerializedPramanError

Structured representation with all diagnostic fields.

Example​

const json = error.toJSON();
logger.debug(JSON.stringify(json, null, 2));

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());

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​

Error.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​

Error.prepareStackTrace