Class ApiError

Base class for custom errors throw by the API.

Hierarchy

Constructors

constructor

Properties

data? message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

  • Parameters

    • Optional message: string

      Description of the error.

    • Optional error: any

      The originating error, if relevant.

    Returns ApiError

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: Error, stackTraces: CallSite[]) => any)

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc