Skip to main content
Version: 1.x

Class: ControlError

Error subclass for UI5 control interaction failures.

Ai Context​

Self-healing fields: lastKnownSelector, availableControls, suggestedSelector — enable AI agents to suggest corrected selectors

Failure Mode​

Not found — control ID or selector matches no controls in the UI5 view

Failure Mode​

Not visible — control exists but is hidden or not in the visible DOM

Failure Mode​

Not interactable — control is visible but disabled or read-only

Browser Context​

Requires active UI5 page with rendered controls

Example​

const error = new ControlError({
  message: 'Button not found',
  attempted: 'Find button with ID: submitBtn',
  suggestedSelector: { id: 'btn1' },
});

Extends​

Constructors​

Constructor​

new ControlError(options): ControlError

Creates a new ControlError instance.

Parameters​

options​

ControlErrorOptions

Control error construction options including self-healing selector fields.

Returns​

ControlError

Example​

import { ControlError } from '#core/errors/control-error.js';

const error = new ControlError({
  message: 'Control not found: submitBtn',
  attempted: 'Find control with ID: submitBtn',
  lastKnownSelector: { id: 'oldSubmitBtn' },
  availableControls: ['btn1', 'btn2'],
  suggestedSelector: { id: 'btn1' },
});

Overrides​

PramanError.constructor

Properties​

attempted​

readonly attempted: string

Inherited from​

PramanError.attempted

availableControls​

readonly availableControls: readonly string[]

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

lastKnownSelector​

readonly lastKnownSelector: UI5Selector | undefined

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

suggestedSelector​

readonly suggestedSelector: UI5Selector | undefined

suggestions​

readonly suggestions: readonly string[]

Inherited from​

PramanError.suggestions

timestamp​

readonly timestamp: string

Inherited from​

PramanError.timestamp

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 control self-healing fields.

Returns​

AIErrorContext & object

Base AI context plus lastKnownSelector, availableControls, and suggestedSelector fields to enable AI-driven selector correction.

Example​

const context = error.toAIContext();
// context.lastKnownSelector — the selector that previously worked
// context.availableControls — controls currently in the view
// context.suggestedSelector — best-match selector suggestion

Overrides​

PramanError.toAIContext

toJSON()​

toJSON(): SerializedPramanError & object

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

Returns​

SerializedPramanError & object

Base fields plus lastKnownSelector, availableControls, and suggestedSelector.

Example​

const json = error.toJSON();
// json.lastKnownSelector === { id: 'oldSubmitBtn' }
// json.availableControls === ['btn1', 'btn2']
// json.suggestedSelector === { id: 'btn1' }

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