Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApiException<T>

Represents an error caused by an api call i.e. it has attributes for a HTTP status code and the returned body object.

Example API returns a ErrorMessageObject whenever HTTP status code is not in [200, 299] => ApiException(404, someErrorMessageObject)

Type Parameters

  • T

Hierarchy

  • Error
    • ApiException

Index

Constructors

Properties

Methods

Constructors

constructor

  • new ApiException<T>(code: number, message: string, body: T, headers: {}): ApiException<T>

Properties

body

body: T

code

code: number

headers

headers: {}

Type declaration

  • [key: string]: string

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

  • captureStackTrace(targetObject: object, constructorOpt?: Function): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Generated using TypeDoc