Skip to main content
Version: 1.x

Class: AIError

Error subclass for AI provider failures.

Ai Context​

AI provider failure context enabling LLM self-healing

Example​

const error = new AIError({
  message: 'Provider unavailable',
  attempted: 'Generate test steps',
  provider: 'azure-openai',
});

Extends​

Constructors​

Constructor​

new AIError(options): AIError

Creates a new AIError instance.

Parameters​

options​

AIErrorOptions

AI error construction options including provider context.

Returns​

AIError

Example​

import { AIError } from '#core/errors/ai-error.js';

const error = new AIError({
  message: 'Token limit exceeded for GPT-4o',
  attempted: 'Generate test steps from intent',
  provider: 'azure-openai',
  model: 'gpt-4o',
  tokenUsage: { prompt: 12000, completion: 0, total: 12000 },
});

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

details​

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

Inherited from​

PramanError.details

message​

message: string

Inherited from​

PramanError.message

model​

readonly model: string | undefined

name​

name: string

Inherited from​

PramanError.name

provider​

readonly provider: string | undefined

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

tokenUsage​

readonly tokenUsage: TokenUsage | undefined

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 provider diagnostics.

Returns​

AIErrorContext & object

Base AI context plus provider, model, and tokenUsage fields to enable LLM self-healing and retry decisions.

Example​

const context = error.toAIContext();
// context.provider, context.model, context.tokenUsage available
// Send to LLM for provider fallback or token budget adjustment

Overrides​

PramanError.toAIContext

toJSON()​

toJSON(): SerializedPramanError & object

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

Returns​

SerializedPramanError & object

Base fields plus provider, model, and tokenUsage.

Example​

const json = error.toJSON();
// json.provider === 'azure-openai'
// json.model === 'gpt-4o'
// json.tokenUsage === { prompt: 12000, completion: 0, total: 12000 }

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