Class TierError

Error subclass raised for any error returned by the API. Should not be instantiated directly.

Hierarchy

  • Error
    • TierError

Constructors

constructor

Properties

cause? code? message name path requestData responseData stack? status prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

  • Parameters

    • path: string
    • reqBody: any
    • status: number
    • resBody: any
    • Optional er: any

    Returns TierError

Properties

Optional cause

cause?: Error

An underlying system error or other cause.

Optional code

code?: string

The code field in the ErrorResponse

message

message: string

name

name: string

path

path: string

The API endpoint that was requested

requestData

requestData: any

The data that was sent to the API endpoint. Will be a parsed JavaScript object unless the request JSON was invalid, in which case it will be a string.

responseData

responseData: any

The HTTP response body. Will be a parsed JavaScript object unless the response JSON was invalid, in which case it will be a string.

Optional stack

stack?: string

status

status: number

The HTTP response status code returned

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