Skip to content

Class: VelloraUnsupportedError

Defined in: packages/vellora/src/errors.ts:103

An out-of-subset construct reported by the core. Carries the located diagnostic verbatim so consumers and CI can surface a precise, actionable message and branch on it.

Extends

Constructors

Constructor

new VelloraUnsupportedError(diagnostic): VelloraUnsupportedError

Defined in: packages/vellora/src/errors.ts:113

Parameters

diagnostic

UnsupportedDiagnostic

Returns

VelloraUnsupportedError

Overrides

VelloraError.constructor

Properties

cause?

optional cause?: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

VelloraError.cause


code

readonly code: VelloraErrorCode

Defined in: packages/vellora/src/errors.ts:22

Stable, machine-readable discriminator.

Inherited from

VelloraError.code


col

readonly col: number | null

Defined in: packages/vellora/src/errors.ts:109

1-based source column of the offending node, or null when the source position is unknown.


feature

readonly feature: string

Defined in: packages/vellora/src/errors.ts:105

The out-of-subset feature reported by the core.


hint

readonly hint: string

Defined in: packages/vellora/src/errors.ts:111

Remediation hint from the core.


line

readonly line: number | null

Defined in: packages/vellora/src/errors.ts:107

1-based source line of the offending node, or null when the source position is unknown.


message

message: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

VelloraError.message


name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

VelloraError.name


stack?

optional stack?: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

VelloraError.stack


stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:68

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.

Inherited from

VelloraError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

js
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:

js
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

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

VelloraError.captureStackTrace


prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:56

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

VelloraError.prepareStackTrace