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: FunctionStaticprepareOptionalcauseReadonlydataThe raw response body returned by the API.
SECURITY: For AptosApiType.PEPPER and AptosApiType.PROVER, this can
contain sensitive keyless-flow material (JWT claims, pepper-derived
state). It is NOT redacted here — only Error.message is. Treat
error.data as sensitive when handling errors from those API types,
especially before passing the error to a structured logger or crash
reporter.
ReadonlyrequestOptionalstackReadonlystatusReadonlystatusReadonlyurlStaticstackThe 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.
Represents an error returned from the Aptos API. This class encapsulates the details of the error, including the request URL, response status, and additional data.
Param: name
The name of the error, which is always "AptosApiError".
Param: url
The URL to which the request was made.
Param: status
The HTTP response status code (e.g., 400).
Param: statusText
The message associated with the response status.
Param: data
The response data returned from the API.
Param: request
The original AptosRequest that triggered the error.
SECURITY:
Error.messageis sanitized forAptosApiType.PEPPERandAptosApiType.PROVERso that response bodies (which can contain JWT claims or pepper-derived material) don't leak into default log/crash sinks. Thedatafield, however, ALWAYS holds the raw response body — including for those sensitive API types — so callers that log or serializeAptosApiError.data(e.g.,JSON.stringify(error), Sentry's automatic field capture, custom structured loggers) must treat it accordingly. If you only need a human-readable summary, prefererror.message.