Class CommercetoolsError

The error class thrown by any of the utility classes.

Hierarchy

  • Error
    • CommercetoolsError

Constructors

constructor

Properties

cause? data? isCommercetoolsError message name stack? status prepareStackTrace? stackTraceLimit

Methods

toJSON toString captureStackTrace fromAxiosError isInstance parseRequestData

Constructors

constructor

Properties

Optional cause

cause?: unknown

Optional Readonly data

data?: any

The data passed in to the error class. This could be anything, but is most likely to be the response from a commercetools request.

Readonly isCommercetoolsError

isCommercetoolsError: true = true

Convenience mechanism for identifying that the error that's just been caught is a CommercetoolsError.

message

message: string

name

name: string

Optional stack

stack?: string

Readonly status

status: undefined | number

If available, this is the status code of the request received back from commercetools: https://docs.commercetools.com/api/errors

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

toJSON

toString

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static fromAxiosError

Static isInstance

Static parseRequestData

  • parseRequestData(config): any

  • Parse the JSON string back in to an object for easier viewing

    Parameters

    • config: undefined | InternalAxiosRequestConfig<any>

    Returns any

Settings

Member Visibility

Theme

On This Page

constructorcausedataisCommercetoolsErrormessagenamestackstatusprepareStackTracestackTraceLimittoJSONtoStringcaptureStackTracefromAxiosErrorisInstanceparseRequestData