one of HttpTransportErrorCode
Optionaloptions: { cause?: unknown } = {}Optionalcause?: unknownthe native failure this classifies
OptionalcauseReadonlycodeOptionalstackStaticstackThe 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: FunctionStatichasStaticisIndicates whether the argument provided is a built-in Error instance or not.
StaticisWhether value is an HttpTransportError, by shape rather than by
instanceof: a third-party transport may hold a second copy of this
class (the CommonJS build next to the ESM one), and its errors must
still be classified.
Staticistrue only for an HttpTransportError whose code is retryable. Any
other value, including an unrecognised failure from a third-party
transport, is not retried.
Staticprepare
A failure to obtain a response from an
HttpTransport.A non-2xx status is not one of these: it is a successful exchange whose
HttpResponsecarries the status. The SDK's own transports always classify a failure into one of theHttpTransportErrorCodevalues. A third-party transport should too, and may otherwise throw anything: a failure the mirror node adapter does not recognise is treated as non-retryable, so a badly wrapped proxy surfaces after one attempt instead of burning the whole budget.