Class ApiError

Base class for custom errors throw by the API.

Hierarchy

Error
- ApiError

Index

Constructors

Properties

data? message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

new ApiError(message?, error?): ApiError
Parameters
- Optional message: string
  Description of the error.
- Optional error: any
  The originating error, if relevant.
Returns ApiError
Overrides Error.constructor

Properties

`Optional` data

data?: any

Additional data provided as part of the error.

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

Generated using TypeDoc