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

Constructors

constructor

Properties

body code headers message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

Properties

body

body: T

code

code: number

headers

headers: {
    [key: string]: string;
}

message

message: string

name

name: string

Optionalstack

stack?: string

Static OptionalprepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

See

https://github.com/v8/v8/wiki/Stack Trace API#customizing-stack-traces

StaticstackTraceLimit

stackTraceLimit: number

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: Object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods