Class ServiceApiError

ServiceApiError is thrown when an underlying service API call results in an error.

See

Hierarchy

  • Error
    • ServiceApiError

Constructors

constructor

Properties

_errorCode _requestTrackingId _statusCode name stack? DEFAULT_ERROR_CODE DEFAULT_STATUS_CODE prepareStackTrace? stackTraceLimit

Accessors

errorCode message requestTrackingId statusCode

Methods

captureStackTrace

Constructors

constructor

  • new ServiceApiError(message, requestTrackingId, statusCode?, errorCode?): ServiceApiError

  • Constructs a ServiceApiError with the specified detail message, request tracking id, status code and error code.

    Parameters

    • message: string

      error message detail

    • requestTrackingId: string

      X-Request-Id header value to track the request

    • Optional statusCode: number

      HTTP Status code returned in API response

    • Optional errorCode: string

      Error code returned in API response

    Returns ServiceApiError

Properties

Private Readonly _errorCode

_errorCode: string

Private Readonly _requestTrackingId

_requestTrackingId: string

Private Readonly _statusCode

_statusCode: number

name

name: string

Optional stack

stack?: string

Static Private DEFAULT_ERROR_CODE

DEFAULT_ERROR_CODE: string = "UNKNOWN"

the default value of error code if there is no error code for this service failure.

Static Private DEFAULT_STATUS_CODE

DEFAULT_STATUS_CODE: number = 0

the default value of status code if there is no status code for this service failure.

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

Accessors

errorCode

  • get errorCode(): string

  • Returns the Error code or DEFAULT_ERROR_CODE="UNKNOWN" if the error code doesn't adequately represent the error.

    Returns string

    the Error code or DEFAULT_ERROR_CODE="UNKNOWN" if the error code doesn't adequately represent the error.

message

  • get message(): string

  • Returns the detail message of this error.

    Returns string

    the message detail.

requestTrackingId

  • get requestTrackingId(): string

  • Returns the Request ID (the value of the X-Request-ID header).

    Returns string

    Request ID

statusCode

  • get statusCode(): number

  • Returns the HTTP Status code or DEFAULT_STATUS_CODE=0 if the status code doesn't adequately represent the error.

    Returns number

    the HTTP Status code or DEFAULT_STATUS_CODE=0 if the status code doesn't adequately represent the error.

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

constructor_errorCode_requestTrackingId_statusCodenamestackDEFAULT_ERROR_CODEDEFAULT_STATUS_CODEprepareStackTracestackTraceLimiterrorCodemessagerequestTrackingIdstatusCodecaptureStackTrace

Generated using TypeDoc