Skip to main content
Version: 1.x

Class: SelectorError

Error subclass for selector parsing/resolution failures.

Remarks​

Thrown when a UI5 selector string has invalid syntax, matches multiple controls when a single match is expected, or cannot be tokenized by the selector parser. Includes the raw selectorString and, when available, the partially parsedSelector for diagnostic inspection.

Failure Mode​

Invalid syntax — selector string does not match expected format

Failure Mode​

Ambiguous match — selector matches multiple controls when single expected

Failure Mode​

Parse failure — selector expression could not be tokenized

Ai Context​

Selector correction hints for AI agents — suggestedSelector field provides alternatives

Example​

const error = new SelectorError({
  message: 'Ambiguous selector matched 3 controls',
  attempted: 'Resolve selector to single control',
  code: 'ERR_SELECTOR_AMBIGUOUS',
  selectorString: 'sap.m.Button',
});

Extends​

Constructors​

Constructor​

new SelectorError(options): SelectorError

Creates a new SelectorError instance.

Parameters​

options​

SelectorErrorOptions

Selector error construction options including the optional selectorString and parsedSelector diagnostic fields. Defaults: code = ERR_SELECTOR_INVALID, retryable = false.

Returns​

SelectorError

Example​

import { SelectorError } from '#core/errors/selector-error.js';

const error = new SelectorError({
  message: 'Invalid selector syntax: missing control type',
  attempted: 'Parse selector: ui5=sap.m.Button#save',
  selectorString: 'ui5=sap.m.Button#save',
  suggestions: ['Use format: controlType=sap.m.Button'],
});

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

name​

name: string

Inherited from​

PramanError.name

parsedSelector​

readonly parsedSelector: UI5Selector | undefined

retryable​

readonly retryable: boolean

Inherited from​

PramanError.retryable

selectorString​

readonly selectorString: string | undefined

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

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 to reason about the selector failure.

Returns​

AIErrorContext & object

AI-friendly context object with selector diagnostic fields.

Remarks​

Extends the base AI context with selectorString and parsedSelector so AI agents can suggest corrected selectors.

Example​

import { SelectorError } from '#core/errors/selector-error.js';

const error = new SelectorError({
  message: 'Ambiguous selector',
  attempted: 'Find single control',
  selectorString: 'sap.m.Button',
});
const context = error.toAIContext();
// context.selectorString === 'sap.m.Button'

Overrides​

PramanError.toAIContext

toJSON()​

toJSON(): SerializedPramanError & object

Serializes the error to a plain JSON-safe object.

Returns​

SerializedPramanError & object

Base serialized fields plus selectorString and parsedSelector.

Example​

import { SelectorError } from '#core/errors/selector-error.js';

const error = new SelectorError({
  message: 'Invalid selector',
  attempted: 'Parse selector string',
  selectorString: 'sap.m.Input',
});
const json = error.toJSON();
// json.selectorString === 'sap.m.Input'

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