Skip to main content

Class: SchemaValidationError

Defined in: packages/core/src/domain/errors/schema-validation-error.ts:10

Thrown when a schema file fails structural validation during SchemaRegistry.resolve().

Carries the schema reference that triggered the failure and a human-readable reason describing which constraint was violated.

Extends​

Constructors​

Constructor​

new SchemaValidationError(ref, reason): SchemaValidationError

Defined in: packages/core/src/domain/errors/schema-validation-error.ts:25

Creates a new SchemaValidationError for a schema that failed validation.

Parameters​

ref​

string

The schema reference string (e.g. "@specd/schema-std", "#billing:my-schema")

reason​

string

A human-readable description of the violated constraint

Returns​

SchemaValidationError

Overrides​

SpecdError.constructor

Properties​

cause?​

optional cause?: unknown

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

Inherited from​

SpecdError.cause

message​

message: string

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

Inherited from​

SpecdError.message

name​

name: string

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

Inherited from​

SpecdError.name

stack?​

optional stack?: string

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

Inherited from​

SpecdError.stack

stackTraceLimit​

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@22.19.11/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​

SpecdError.stackTraceLimit

Accessors​

code​

Get Signature​

get code(): string

Defined in: packages/core/src/domain/errors/schema-validation-error.ts:15

Machine-readable error code identifying this error class.

Returns​

string

Overrides​

SpecdError.code

reason​

Get Signature​

get reason(): string

Defined in: packages/core/src/domain/errors/schema-validation-error.ts:45

A human-readable description of the violated constraint.

Returns​

string

The validation failure reason

ref​

Get Signature​

get ref(): string

Defined in: packages/core/src/domain/errors/schema-validation-error.ts:36

The schema reference that failed validation.

Returns​

string

The original ref string passed to SchemaRegistry.resolve()

Methods​

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@22.19.11/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.

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​

targetObject​

object

constructorOpt?​

Function

Returns​

void

Inherited from​

SpecdError.captureStackTrace

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@22.19.11/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​

SpecdError.prepareStackTrace