Class ApiError

Hierarchy

Error
- ApiError

Implements

IApiError

Index

Constructors

Properties

additionalContent errcode error message name stack statusCode prepareStackTrace stackTraceLimit

Accessors

Methods

apply captureStackTrace

Constructors

constructor

new ApiError(error: string, errcode?: ErrCode, statusCode?: number, additionalContent?: Record<string, unknown>): ApiError
Parameters
- error: string
- errcode: ErrCode = ErrCode.Unknown
- statusCode: number = -1
- additionalContent: Record<string, unknown> = {}
Returns ApiError

Overrides Error.constructor

Properties

`Readonly` additionalContent

additionalContent: Record<string, unknown> = {}

`Readonly` errcode

errcode: ErrCode = ErrCode.Unknown

`Readonly` error

error: string

message

message: string

name

name: string

`Optional` stack

stack?: string

`Readonly` statusCode

statusCode: number = -1

`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

jsonBody

get jsonBody(): { errcode: string; error: string }
Returns { errcode: string; error: string }
- errcode: string
- error: string

Methods

apply

apply(response: Response<any, Record<string, any>>): void
Parameters
- response: Response<any, Record<string, any>>
Returns void

Implementation of IApiError.apply

`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

Generated using TypeDoc