AboutSupportDeveloper GuideVersion 2.0.0

Class ApiError

Base class for custom errors throw by the API.

Hierarchy (view full)

Constructors

constructor

Properties

data? message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

  • new ApiError(message?, data?): ApiError

  • Parameters

    • message: string = 'An unexpected error has occurred'
    • Optional data: unknown

    Returns ApiError

Properties

Optional data

data?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc