Optionaloptions: {Options passed to NodeAssertionError's constructor
Optionalmessage?: stringIf provided, the error message is set to this value.
Optionalactual?: unknownThe actual property on the error instance.
Optionalexpected?: unknownThe expected property on the error instance.
Optionaloperator?: stringThe operator property on the error instance.
OptionalstackStartFn?: FunctionIf provided, the generated stack trace omits frames before this function.
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.
Set to the actual argument for methods such as ().
Set to the expected argument for methods such as ().
Set to the passed in operator value.
Indicates if the message was auto-generated (true) or not.
Value is always ERR_ASSERTION to show that the error is an assertion error.
OptionalstackOptionalcauseStaticisType guard for an instance of this error.
Some value
true if value is an instance of AssertionError
StaticisIndicates whether the argument provided is a built-in Error instance or not.
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: FunctionStaticprepare
BUPKIS' s custom
AssertionErrorclass, which is just a thin wrapper around Node.js' AssertionError.