Skip to main content
Version: 1.x

Class: TimeoutError

Error subclass for operation timeout failures.

Remarks​

Thrown when UI5 stability waits, control discovery, or generic operations exceed their configured timeout. The timeoutMs field always reflects the configured limit, and elapsed captures the actual wall-clock time when available.

Failure Mode​

UI5 stability timeout — UI5 framework did not reach stable state

Failure Mode​

Control discovery timeout — target control not found within timeout period

Guarantee​

Always includes configured timeoutMs value in error details

Example​

const error = new TimeoutError({
  message: 'UI5 stability check timed out after 30s',
  attempted: 'Wait for UI5 to stabilize',
  timeoutMs: 30000,
  elapsed: 30123,
});

Extends​

Constructors​

Constructor​

new TimeoutError(options): TimeoutError

Creates a new TimeoutError instance.

Parameters​

options​

TimeoutErrorOptions

Timeout error construction options including the required timeoutMs and optional elapsed diagnostic fields. Defaults: code = ERR_TIMEOUT_OPERATION, retryable = true.

Returns​

TimeoutError

Example​

import { TimeoutError } from '#core/errors/timeout-error.js';

const error = new TimeoutError({
  message: 'Control not found within 10s',
  attempted: 'Discover control: sap.m.Button#save',
  code: 'ERR_TIMEOUT_CONTROL_DISCOVERY',
  timeoutMs: 10000,
  elapsed: 10045,
  suggestions: ['Increase controlDiscoveryTimeout in config'],
});

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

elapsed​

readonly elapsed: number | 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

suggestions​

readonly suggestions: readonly string[]

Inherited from​

PramanError.suggestions

timeoutMs​

readonly timeoutMs: number

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 timeout failure.

Returns​

AIErrorContext & object

AI-friendly context object with timeout diagnostic fields.

Remarks​

Extends the base AI context with timeoutMs and elapsed so AI agents can recommend timeout adjustments or identify slow-loading pages.

Example​

import { TimeoutError } from '#core/errors/timeout-error.js';

const error = new TimeoutError({
  message: 'UI5 stability timed out',
  attempted: 'Wait for UI5 stable state',
  timeoutMs: 30000,
  elapsed: 30500,
});
const context = error.toAIContext();
// context.timeoutMs === 30000, context.elapsed === 30500

Overrides​

PramanError.toAIContext

toJSON()​

toJSON(): SerializedPramanError & object

Serializes the error to a plain JSON-safe object.

Returns​

SerializedPramanError & object

Base serialized fields plus timeoutMs and elapsed.

Example​

import { TimeoutError } from '#core/errors/timeout-error.js';

const error = new TimeoutError({
  message: 'Timed out',
  attempted: 'Wait for stability',
  timeoutMs: 5000,
});
const json = error.toJSON();
// json.timeoutMs === 5000

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