Type of the underlying cause.
Creates a new localized exception.
Type of the underlying cause.
Application-specific error code (e.g. 'queue.job.cancelled').
Translations, params, default locale, and cause.
ReadonlycauseOriginal error or value that triggered this exception.
ReadonlycodeApplication-specific error code (e.g. 'jwt.token.expired').
ReadonlydefaultLocale used to build the default message string.
ReadonlyparamsParameter values interpolated into {{placeholder}} tokens.
OptionalstackReadonlytranslationsAll available translations keyed by locale.
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.
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: FunctionCreate .stack property on a target object
OptionalconstructorOpt: FunctionStaticisIndicates whether the argument provided is a built-in Error instance or not.
Check if a value is an instance of Error
The value to check
True if the value is an instance of Error, false otherwise
Staticprepare
Exception carrying translated messages, for applications with no HTTP layer (workers, CLIs, queue consumers). For an API, use LocalizedHttpException instead.
messageholds the raw template for the default locale; resolveMessage interpolates it for any locale.