Optional
data: anyOptional
status: numberOptional
causeOptional
Readonly
dataThe data passed in to the error class. This could be anything, but is most likely to be the response from a commercetools request.
Readonly
isConvenience mechanism for identifying that the error that's just been caught is a CommercetoolsError.
Optional
stackReadonly
statusIf available, this is the status code of the request received back from commercetools: https://docs.commercetools.com/api/errors
Static
stackThe Error.stackTraceLimit
property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack
or
Error.captureStackTrace(obj)
).
The default value is 10
but may be set to any valid JavaScript number. Changes
will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Returns a string representation of an object.
Static
captureCreates a .stack
property on targetObject
, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace()
was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`
The first line of the trace will be prefixed with
${myObject.name}: ${myObject.message}
.
The optional constructorOpt
argument accepts a function. If given, all frames
above constructorOpt
, including constructorOpt
, will be omitted from the
generated stack trace.
The constructorOpt
argument is useful for hiding implementation
details of error generation from the user. For instance:
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();
Optional
constructorOpt: FunctionStatic
fromUtility for converting an AxiosError in to a CommercetoolsError.
Optional
messageOverride: stringStatic
isStatic
parseParse the JSON string back in to an object for easier viewing
Static
prepare
The error class thrown by any of the utility classes.