Vizel API / core/src / VizelError

Class: VizelError

Defined in: packages/core/src/utils/errorHandling.ts:67

Structured error class for Vizel operations.

Extends Error so callers get stack traces and instanceof checks. The underlying cause flows through the standard Error.cause property; consumers read err.cause to reach the wrapped error.

Extends

• Error

Constructors

Constructor

new VizelError(
   code, 
   message, 
   options?): VizelError;

Defined in: packages/core/src/utils/errorHandling.ts:72

Parameters

Parameter	Type
code	VizelErrorCode
message	string
options?	VizelErrorOptions

Returns

VizelError

Overrides

Error.constructor

Properties

code

readonly code: VizelErrorCode;

Defined in: packages/core/src/utils/errorHandling.ts:68

---

context?

readonly optional context?: Record<string, unknown>;

Defined in: packages/core/src/utils/errorHandling.ts:70

---

severity

readonly severity: VizelErrorSeverity;

Defined in: packages/core/src/utils/errorHandling.ts:69

Methods

captureStackTrace()?

Call Signature

static optional captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@types+node@25.9.4/node_modules/@types/node/globals.d.ts:51

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

Parameters

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

Call Signature

static optional captureStackTrace(targetObject, constructorOpt?): void;

Defined in: packages/core/src/env.d.ts:3

Parameters

Parameter	Type
targetObject	object
constructorOpt?	NewableFunction

Returns

void

Inherited from

Error.captureStackTrace