Class AbstractError

Base class for all errors.

Hierarchy (View Summary)

Error
- AbstractError

Index

Constructors

Properties

cause? code message name stack? status prepareStackTrace? stackTraceLimit

Methods

captureStackTrace isAbstractError

Constructors

constructor

new AbstractError(code: string, message: string, status: number): AbstractError
Constructs a new AbstractError.
Parameters
- code: string
  The main identification code for the error.
- message: string
  The main error message.
- status: number
  The HTTP status code to return.
Returns AbstractError
Overrides Error.constructor
- Defined in source/errors/AbstractError.ts:21

Properties

`Optional`cause

cause?: unknown

code

code: string

An application-unique, readable error code.

message

message: string

name

name: string

`Optional`stack

stack?: string

status

status: number

The HTTP status code to associate with this error.

`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

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
- Defined in node_modules/@types/node/globals.d.ts:136

`Static`isAbstractError

isAbstractError(
error: unknown,
allowForeignModule?: boolean,
): error is AbstractError
Checks if an object is an instance of AbstractError, or one of its subclasses.
Parameters
- error: unknown
  The object to check.
- allowForeignModule: boolean = true
  Only check for similar looking error codes. You're going to want to use this if you're dealing with a setup where multiple versions of js-utils are loaded.
Returns error is AbstractError
true if the object is an AbstractError, false otherwise.
- Defined in source/errors/AbstractError.ts:43