A wrapper for API errors to provide more context.

Hierarchy (view full)

Constructors

Properties

apiCode: null | string
apiMessage: null | string
cause?: Error
code?: string
config?: InternalAxiosRequestConfig<any>
correlationId: null | string
httpCode: null | number
isAxiosError: boolean
message: string
name: string
request?: any
response?: AxiosResponse<unknown, any>
stack?: string
status?: number
toJSON: (() => object)

Type declaration

    • (): object
    • Returns object

ECONNABORTED: "ECONNABORTED" = "ECONNABORTED"
ERR_BAD_OPTION: "ERR_BAD_OPTION" = "ERR_BAD_OPTION"
ERR_BAD_OPTION_VALUE: "ERR_BAD_OPTION_VALUE" = "ERR_BAD_OPTION_VALUE"
ERR_BAD_REQUEST: "ERR_BAD_REQUEST" = "ERR_BAD_REQUEST"
ERR_BAD_RESPONSE: "ERR_BAD_RESPONSE" = "ERR_BAD_RESPONSE"
ERR_CANCELED: "ERR_CANCELED" = "ERR_CANCELED"
ERR_DEPRECATED: "ERR_DEPRECATED" = "ERR_DEPRECATED"
ERR_FR_TOO_MANY_REDIRECTS: "ERR_FR_TOO_MANY_REDIRECTS" = "ERR_FR_TOO_MANY_REDIRECTS"
ERR_INVALID_URL: "ERR_INVALID_URL" = "ERR_INVALID_URL"
ERR_NETWORK: "ERR_NETWORK" = "ERR_NETWORK"
ERR_NOT_SUPPORT: "ERR_NOT_SUPPORT" = "ERR_NOT_SUPPORT"
ETIMEDOUT: "ETIMEDOUT" = "ETIMEDOUT"
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

  • Type Parameters

    • T = unknown
    • D = any

    Parameters

    • error: unknown
    • Optional code: string
    • Optional config: InternalAxiosRequestConfig<D>
    • Optional request: any
    • Optional response: AxiosResponse<T, D>
    • Optional customProps: object

    Returns AxiosError<T, D>