Optionalbody: unknownOptionalurl: stringOptionalmethod: stringOptional ReadonlybodyThe full parsed JSON response body, when available.
Optional ReadonlycodeApplication error code from the response body, if present.
E.g. "INSUFFICIENT_FUNDS", "CALL_EXCEPTION".
Optional ReadonlymethodThe HTTP method (e.g. GET, POST), when available.
OptionalstackReadonlystatusHTTP status code (e.g. 500, 404).
Optional ReadonlyurlThe request URL, when available.
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
Thrown when an API request returns a non-ok HTTP status.
Surfaces the parsed response body so callers (and duck-type checks like isInsufficientFundsError) can inspect
.codeand.messagewithout losing the raw response.In some cases the API reports an insufficient-gas style error (e.g.
codeINSUFFICIENT_FUNDS); use isInsufficientFundsError to detect that and treat it like other insufficient-funds errors.When the API returns a 403 status, an InsufficientPermissions instance is returned instead, indicating the caller lacks the required permissions for the requested action.