Class FlexSdkError

Custom error class thrown by the Flex SDK with structured error codes and metadata.

Hierarchy

Error
- FlexSdkError

Index

Constructors

Properties

cause? message name stack? prepareStackTrace? stackTraceLimit

Accessors

code details metadata

Methods

captureStackTrace

Constructors

constructor

new FlexSdkError(
    errorCode: ErrorCode,
    metadata?: FlexSdkErrorMetadata,
    details?: string,
    cause?: unknown,
): FlexSdkError
Parameters
- errorCode: ErrorCode
- Optionalmetadata: FlexSdkErrorMetadata
- Optionaldetails: string
- Optionalcause: unknown
Returns FlexSdkError
Overrides Error.constructor

Properties

`Optional`cause

cause?: unknown

message

message: string

name

name: string

`Optional`stack

stack?: string

`Static` `Optional`prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

`Static`stackTraceLimit

stackTraceLimit: number

Accessors

code

get code(): ErrorCode
Error code

Returns ErrorCode

details

get details(): undefined | string
Detailed information about what caused the error

Returns undefined | string

metadata

get metadata(): FlexSdkErrorMetadata
Gets the metadata about the error

Returns FlexSdkErrorMetadata

Methods

`Static`captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void
Create .stack property on a target object
Parameters
- targetObject: object
- OptionalconstructorOpt: Function
Returns void
Inherited from Error.captureStackTrace