OptionalcauseReadonlycodeType-safe error code from ERROR_CODES registry See error-codes.ts for the complete registry
Optional ReadonlymetadataAdditional structured data about the error Used for:
OptionalstackReadonlytimestampISO timestamp when the error was created
StaticstackThe 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.
Serialize error to ErrorResponse format for RPC transmission
Environment (development | production)
OptionaltranslatedMessage: stringOptional translated message (from GlobalErrorHandler)
ErrorResponse object suitable for JSON serialization
JSON serialization (used by JSON.stringify) Defaults to development mode for backward compatibility Note: This will use the untranslated message key - use GlobalErrorHandler for proper localization
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
OpenAPIRouteRegistrationError
Thrown when an OpenAPI route fails to register properly This indicates a configuration issue with route decorators or metadata Uses i18n key for localized error messages
Example