Class UnexpectedError

Catch all error class to wrap unknown errors. An error of this class popping up is considered a bug

Hierarchy

Error
- UnexpectedError

Index

Constructors

Properties

cause? message name stack? prepareStackTrace? stackTraceLimit

Methods

newIssueUrl captureStackTrace

Constructors

constructor

new UnexpectedError(error): UnexpectedError
Parameters
- error: unknown
Returns UnexpectedError
Overrides Error.constructor
- Defined in src/errors.ts:33

Properties

`Optional` cause

cause?: 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

newIssueUrl

newIssueUrl(): string
Use this method to generate a url for an issue containing relevant information for this error.

Returns string
clickable url to create an issue for this error
- Defined in src/errors.ts:45

`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