Creates a new CollegeDBError instance
Error message describing what went wrong
Optional
code: stringOptional error code for categorization
Optional
causeThe cause of the error.
Optional
Readonly
codeOptional error code for categorizing different types of errors
Optional
stackStatic
stackThe maximum number of stack frames to capture.
Static
captureCreate .stack property on a target object
Optional
constructorOpt: FunctionCreates 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();
Optional
constructorOpt: FunctionStatic
isCheck if a value is an instance of Error
The value to check
True if the value is an instance of Error, false otherwise
Static
prepare
Custom error class for CollegeDB operations
Extends the native Error class to provide more specific error information for CollegeDB operations. Includes an optional error code for better error categorization and handling.
Example