Creates a new UserFacingError instance.
The main error message.
Optionaloptions: SecondParamOptional hint or ErrorOptions.
OptionalcauseReadonlyhintReadonlynameOptionalstackStaticstackThe 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: FunctionStaticfromCreates a UserFacingError from another error, wrapping it with a new message. It can also include a hint string or boolean.
The original error to wrap.
The new message for the UserFacingError.
Optionaloptions: SecondParamOptional hint or ErrorOptions.
A new UserFacingError instance.
Staticprepare
An error that will be displayed to the user.
Beside the main message, it can include an additional hint message to help the user resolve the issue.
The hint option can also be
trueto indicate that a generic hint should be shown. (e.g. refer to--help).This class extends the standard Error class and also accepts an ErrorOptions object including the
hintproperty beside other standard error properties likecause.