The reason why things didn't go as expected
The server to which the request was sent
The method used for this request (like "get", "post", etc...)
The type of resource that was requested from the server
The filters that were used to specify what resource was wanted
Optionalstatus_code: numberThe status code that was returned by the server, if there is one
Optionaloriginal_error: ErrorThe error that caused the api to throw an APIError in the first place, if there is one
OptionalcauseThe type of resource that was requested from the server
The reason why things didn't go as expected
The method used for this request (like "get", "post", etc...)
Optionaloriginal_The error that caused the api to throw an APIError in the first place, if there is one
The filters that were used to specify what resource was wanted
The server to which the request was sent
OptionalstackOptionalstatus_The status code that was returned by the server, if there is one
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.
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
If the API throws an error, it should always be an APIError!