Class ErrorWithCause

Represents an error that was caused by another error.

Hierarchy

Error
- ErrorWithCause

Index

Constructors

Properties

cause message name stack? prepareStackTrace? stackTraceLimit

Accessors

Methods

captureStackTrace

Constructors

constructor

new ErrorWithCause(message: string, cause: Error): ErrorWithCause
Create an instance of ErrorWithCause.
Parameters
- message: string
  
  Error message.
- cause: Error
  
  Original error, causing this error.
Returns ErrorWithCause
Overrides Error.constructor
- Defined in packages/util/src/error-with-cause.ts:13

Properties

`Readonly` cause

cause: Error

Original error, causing this error.

message

message: string

name

name: string

`Optional` stack

stack?: string

`Static` `Optional` prepareStackTrace

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

Type declaration

- (err: Error, stackTraces: CallSite[]): any
- Optional override for formatting stack traces
  
  See
  https://v8.dev/docs/stack-trace-api#customizing-stack-traces
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any

`Static` stackTraceLimit

stackTraceLimit: number

Accessors

rootCause

get rootCause(): Error
Root cause of the error. If there are multiple errors caused one by another, the root cause is the first error that occurred. In case there is no root cause.

Returns
The root cause.

Returns Error
- Defined in packages/util/src/error-with-cause.ts:42

Methods

`Static` captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void
Create .stack property on a target object
Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void
Inherited from Error.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:4

Copyright Ⓒ 2023 SAP SE or an SAP affiliate company. All rights reserved.