Create a new Amplify Library Fault
a user friendly name for the exception
error stack, resolution steps, details, or help links
Optionalcause: ErrorIf you are throwing this exception from within a catch block, you must provide the exception that was caught.
Optional ReadonlycauseIf you are throwing this exception from within a catch block, you must provide the exception that was caught.
ReadonlyclassificationLibraryFault or UserError
Optional ReadonlycodeOptional ReadonlydetailsOptional ReadonlylinkReadonlymessageReadonlynamea user friendly name for the exception
Optional ReadonlyresolutionOptionalserializedOptionalstackStaticstackThe 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: FunctionStaticfromStaticfromStaticisThis function is a type predicate for AmplifyError. See https://www.typescriptlang.org/docs/handbook/2/narrowing.html#using-type-predicates.
Checks if error is an AmplifyError by inspecting if required properties are set. This is recommended instead of instanceof operator. The instance of operator does not work as expected if AmplifyError class is loaded from multiple sources, for example when package manager decides to not de-duplicate dependencies. See https://github.com/nodejs/node/issues/17943.
Staticprepare
Base class for all Amplify library faults