Creates a new ServiceError
Issues contributing to the error or a message string
OptionalcauseReadonlyidReadonlyissuesReadonlysourceOptionalstackReadonlystatusStaticstackThe 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.
Converts the error to JSON:API format
Object conforming to JSON:API error format
Return string representation of the error for logging.
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: FunctionStaticfromCreates a ServiceError from a JSON:API error object
JSON:API error object
New ServiceError instance
StaticfromConverts an unknown value to a ServiceError. Typically called from catch blocks.
The value to convert, which can be any type
If the value is already a ServiceError, returns it unchanged. Otherwise, convert it
to a ServiceError.
StaticfromConverts a ZodError to a ServiceError.
A ZodError
Optionaloptions: { source?: ErrorSource }The converted ServiceError
Staticprepare
Error class for service-level errors, convertible to JSON:API errors.