Skip to main content
Version: 1.x

Class: FLPError

Error subclass for SAP Fiori Launchpad (FLP) operation failures.

Example​

const error = new FLPError({
  message: 'FLP shell not available',
  attempted: 'Get lock entries via SM12_SRV',
  flpService: 'SM12_SRV',
});

Sap Module​

FLP

Browser Context​

Requires FLP shell loaded in browser

Failure Mode​

Shell not found — FLP shell header not present in the DOM

Failure Mode​

Permission denied — user lacks authorization for the requested FLP operation

Failure Mode​

API unavailable — FLP OData service endpoint unreachable

Extends​

Constructors​

Constructor​

new FLPError(options): FLPError

Creates a new FLPError instance.

Parameters​

options​

FLPErrorOptions

FLP error construction options including service context and optional username for the failing operation.

Returns​

FLPError

Example​

import { FLPError } from '#core/errors/flp-error.js';

const error = new FLPError({
  message: 'FLP shell not found',
  attempted: 'Navigate to Sales Order tile',
  flpService: 'UI2/INTEROP',
  username: 'TESTUSER01',
});

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

flpService​

readonly flpService: string | 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

timestamp​

readonly timestamp: string

Inherited from​

PramanError.timestamp

username​

readonly username: string | 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 AI-agent-friendly context with FLP-specific diagnostic fields.

Returns​

AIErrorContext & object

Base AI context extended with FLP service and user details.

Example​

const ctx = error.toAIContext();
// LLM can use ctx.flpService to suggest corrective navigation
// and ctx.username to verify authorization scope

Overrides​

PramanError.toAIContext

toJSON()​

toJSON(): SerializedPramanError & object

Serializes this error to a JSON-safe object with FLP-specific fields.

Returns​

SerializedPramanError & object

Base serialization extended with flpService and username.

Example​

const json = error.toJSON();
console.log(json.flpService); // 'UI2/INTEROP'
console.log(json.username);   // 'TESTUSER01'

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