Class ApiError

Hierarchy

Error
- ApiError

Index

Constructors

Properties

cause? message name stack? prepareStackTrace? stackTraceLimit

Methods

getApiError captureStackTrace

Constructors

constructor

new ApiError(error: string, description: string): ApiError
Parameters
- error: string
- description: string
Returns ApiError
Overrides Error.constructor

Properties

`Optional`cause

cause?: unknown

message

message: string

name

name: string

`Optional`stack

stack?: string

`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

getApiError

getApiError(): { description: string; error: string }
Get the error name and description returned by the API

Returns { description: string; error: string }
The error name and description in an object

`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
captureStackTrace(targetObject: object, constructorOpt?: Function): void
Create .stack property on a target object
Parameters
- targetObject: object
- OptionalconstructorOpt: Function
Returns void
Inherited from Error.captureStackTrace