ReadonlycauseThe cause property is used to specify the cause of the error. Typically,
this property is used to pass through a related Error instance.
Readonlycodean application-specific error code, expressed as a string value.
Readonlydetaila human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized
ReadonlyhelpAdditional details related to the error that may help the user troubleshoot the issue. If set by the user via the Error constructor, the user provided value will override any automated help message set by the Error class.
Readonlymetaa meta object containing non-standard meta-information about the error.
Optional ReadonlyrequestRelevant for integration errors involving a network call, the requestOptions property
details the request options that resulted in the specified error. The requestOptions property will automatically
have sensitive authentication headers stripped.
OptionalstackReadonlystatusThe HTTP status code applicable to this error, expressed as a string value.
Readonlytitlea short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem except for purposes of localization.
StaticstackThe 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.
Serializes the error's properties into a POJO. The order of the properties is preserved when serialized.
JSON representation of the error
StaticcaptureCreates 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();
OptionalconstructorOpt: FunctionStaticprepare
Thrown by generateAccessToken method if there is a failure to fetch a token