Class sdkApiError

Represents an HOPR SDK API error.

Hierarchy

  • Error
    • sdkApiError

Constructors

constructor

Properties

description? hoprdErrorPayload? message name stack? status statusText prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

  • new sdkApiError(customError): sdkApiError

  • Creates a new instance of the APIError class.

    Parameters

    • customError: {
          description?: string;
          hoprdErrorPayload?: {
              error?: string;
              status: string;
          };
          status: number;
          statusText: string;
      }

      An object containing custom error properties.

      • Optional description?: string
      • Optional hoprdErrorPayload?: {
            error?: string;
            status: string;
        }
        • Optional error?: string
        • status: string
      • status: number
      • statusText: string

    Returns sdkApiError

Properties

Optional description

description?: string

Descriton of the error

Optional hoprdErrorPayload

hoprdErrorPayload?: {
    error?: string;
    status: string;
}

Error Object

Type declaration

  • Optional error?: string
  • status: string

message

message: string

name

name: string

Optional stack

stack?: string

status

status: number

The status code associated with the error

statusText

statusText: string

The status message associated with the error.

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructordescriptionhoprdErrorPayloadmessagenamestackstatusstatusTextprepareStackTracestackTraceLimitcaptureStackTrace