Class ErrorWithExtra

Error with arbitrary extra data attached, for debugging. The extra data is omitted if not running the test in debug mode (?debug=1).

Hierarchy

Error
- ErrorWithExtra

Index

Constructors

Properties

cause? extra message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

new ErrorWithExtra(message, extra): ErrorWithExtra
extra function is only called if in debug mode. If an ErrorWithExtra is passed, its message is used and its extras are passed through.
Parameters
- message: string
- extra: (() => {})
  - - (): {}
    - Returns {}
Returns ErrorWithExtra
Overrides Error.constructor
- Defined in src/common/util/util.ts:19
new ErrorWithExtra(base, newExtra): ErrorWithExtra
Parameters
- base: ErrorWithExtra
- newExtra: (() => {})
  - - (): {}
    - Returns {}
Returns ErrorWithExtra
Overrides Error.constructor
- Defined in src/common/util/util.ts:20

Properties

`Optional` cause

cause?: unknown

`Readonly` extra

extra: {
[k: string]: unknown;
}

Type declaration

[k: string]: unknown

message

message: string

name

name: string

`Optional` stack

stack?: string

`Static` `Optional` prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

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

`Static` stackTraceLimit

stackTraceLimit: number

Methods

`Static` captureStackTrace

captureStackTrace(targetObject, constructorOpt?): 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

Generated using TypeDoc