Creates a new producer error instance.
The human-readable description of the error.
The error options, including the error code.
OptionalcauseAssociated error code.
ReadonlycontextAdditional diagnostic context for the error.
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: FunctionStaticinternalCreates a new producer error with INTERNAL_ERROR code.
The human-readable description of the error.
Optionalcontext: ErrorContext | null
The optional error context.
Optionalcause: unknown
The optional upstream error.
StaticisIndicates whether the argument provided is a built-in Error instance or not.
StaticprepareStaticwrapRe-throws ProducerError instances with additional context, or wraps
unknown errors into a ProducerError with an INTERNAL_ERROR code.
The caught error.
The error context.
A new producer instance.
Error class for producer operation failures.