QubeeError

src/errors/qubee.error.ts2 public methodsclass

Base class for every error this library throws.

Adds three things a bare Error does not give a library consumer:

• code — branch on the failure without matching against English text
• context — the values that caused it, for logging and debugging
• cause — the underlying error, when this one wraps another

Object.setPrototypeOf is required for instanceof to survive when a consumer’s toolchain downlevels the package below ES2015. The core targets ES2022, but a published package does not control how it is transpiled.

Constructor

new QubeeError(code: QubeeErrorCode, message: string, options?: object)

Parameter	Type	Description
code	QubeeErrorCode	Machine-readable identifier for this failure
message	string	Human-readable explanation
options	object	Optional underlying cause and diagnostic context

Properties

Property	Type	Description
cause	unknown	—
code	QubeeErrorCode	Machine-readable identifier for this failure.
context	Record<string, unknown>	The values that produced the error, when they aid diagnosis.
message	string	—
name	string	—
stack	string	—
stackTraceLimit	number	The 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.

Methods

captureStackTrace()

captureStackTrace(targetObject: object, constructorOpt?: Function): void

Creates 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();

Parameter	Type	Description
targetObject	object	—
constructorOpt	Function	—

prepareStackTrace()

prepareStackTrace(err: Error, stackTraces: CallSite[]): any

Parameter	Type	Description
err	Error	—
stackTraces	CallSite[]	—