Creates a new SDKAbortError instance.
Name of the service whose call was cancelled.
Optionalcause: unknown
The abort reason carried by the signal.
ReadonlycanWhether the condition clears on its own, so the same call is likely to succeed later: true for
RATE_LIMITED, LIVE_SERVICE_NOT_AVAILABLE and NETWORK_NOT_AVAILABLE.
OptionalcauseReadonlycodeWhat went wrong, as one of SDKErrorCode. Branch on this value rather than the message.
Optional ReadonlyissuesThe Zod issues of a failed request validation, for an INVALID_REQUEST the SDK raised itself.
ReadonlysdkThe version of the SDK that raised the error, for bug reports.
ReadonlyserviceName of the service where the error occurred.
OptionalstackStaticstackThe 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: FunctionStaticisIndicates whether the argument provided is a built-in Error instance or not.
Staticprepare
Error class for cancelled service calls.
It is thrown when the
signalpassed to a service call is aborted, either before the request is sent or while it is in flight. Itsnameis'AbortError', matching the convention used byfetch. The original abort reason, including a custom value passed toAbortController.abort(reason), is available oncause.To drop a call a newer one supersedes without catching this error, run it through createLatestRequest.
Example