Class AppError

Hierarchy

Error
- AppError

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new AppError(type: AppErrorType, reason: any, message: string, navigationStack: string[]): AppError

Overrides Error.constructor
- Defined in src/Core/ErrorHandling/AppError.ts:41
Parameters
- type: AppErrorType
- reason: any
- message: string
- navigationStack: string[]
Returns AppError

Properties

Protected _additionalPayload

_additionalPayload: PlainObject<any>

Protected _code

_code: number

Protected _el

_el: HTMLElement

Protected _handled

_handled: boolean

Protected _navigationStack

_navigationStack: string[]

Protected _outerStack

_outerStack: string

Protected _reason

_reason: any

Protected _type

_type: AppErrorType

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

Type declaration

- (err: Error, stackTraces: CallSite[]): any
- Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any

Static stackTraceLimit

stackTraceLimit: number

Accessors

additionalPayload

get additionalPayload(): PlainObject<any>
set additionalPayload(value: PlainObject<any>): void

- Defined in src/Core/ErrorHandling/AppError.ts:136
Returns an object containing additional error related information for debugging

Returns PlainObject<any>
- Defined in src/Core/ErrorHandling/AppError.ts:144
Allow to override the additional payload

Parameters
- value: PlainObject<any>
Returns void

code

get code(): number

- Defined in src/Core/ErrorHandling/AppError.ts:113
Returns the error code of this error -> 500 by default

Returns number

el

get el(): HTMLElement

- Defined in src/Core/ErrorHandling/AppError.ts:90
Returns the html element this error is linked to, or undefined

Returns HTMLElement

isAppError

get isAppError(): boolean

- Defined in src/Core/ErrorHandling/AppError.ts:69
Marker to define this error as an app error object

Returns boolean

isHandled

get isHandled(): boolean

- Defined in src/Core/ErrorHandling/AppError.ts:62
Returns true if this error object was already handled

Returns boolean

navigationStack

get navigationStack(): string[]

- Defined in src/Core/ErrorHandling/AppError.ts:97
Returns an array of the last 5 urls which were served before this error was thrown.

Returns string[]

outerStack

get outerStack(): string

- Defined in src/Core/ErrorHandling/AppError.ts:129
Returns the outer stack to track where the AppError was generated

Returns string

reason

get reason(): any

- Defined in src/Core/ErrorHandling/AppError.ts:83
Returns the raw reason why this error was thrown.

Returns any

type

get type(): AppErrorType

- Defined in src/Core/ErrorHandling/AppError.ts:76
Returns the type key of this error object

Returns AppErrorType

Methods

Private __setAsHandled

__setAsHandled(): void

- Defined in src/Core/ErrorHandling/AppError.ts:219
Internal helper to mark this error as handled

Returns void

addAdditionalPayload

addAdditionalPayload(payload: PlainObject<any>): AppError

- Defined in src/Core/ErrorHandling/AppError.ts:152
Can be used to add additional payload to the error

Parameters
- payload: PlainObject<any>
Returns AppError

getSentryExtra

getSentryExtra(): PlainObject<any>

- Defined in src/Core/ErrorHandling/AppError.ts:162
This method provides integration into the @labor-digital/sentry-browser package

Returns PlainObject<any>

setCode

setCode(code: number): AppError

- Defined in src/Core/ErrorHandling/AppError.ts:121
Can be used to set the code of this error object

Parameters
- code: number
Returns AppError

setEl

setEl(el: HTMLElement): AppError

- Defined in src/Core/ErrorHandling/AppError.ts:105
Sets the element this error is linked to

Parameters
- el: HTMLElement
Returns AppError

Static captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void

Inherited from Error.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:4
Create .stack property on a target object

Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void

Generated using TypeDoc