CircularDependencyError

age-schema-client v0.5.0

---

age-schema-client / CircularDependencyError

Class: CircularDependencyError

Defined in: src/schema/errors.ts:131

Error thrown when a circular dependency is detected

Extends

• SchemaValidationError

Constructors

Constructor

new CircularDependencyError(cycle, path?): CircularDependencyError;

Defined in: src/schema/errors.ts:138

Create a new CircularDependencyError

Parameters

Parameter	Type	Description
cycle	string[]	Array of elements in the cycle
path?	string	Path to the cycle

Returns

CircularDependencyError

Overrides

SchemaValidationError.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
stackTraceLimit	static	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.	SchemaValidationError.stackTraceLimit	node_modules/.pnpm/@types+node@22.15.17/node_modules/@types/node/globals.d.ts:161
cause?	readonly	unknown	Error cause	SchemaValidationError.cause	src/schema/errors.ts:17
path?	readonly	string	Path to the invalid element	SchemaValidationError.path	src/schema/errors.ts:57
cycle	readonly	string[]	Array of elements in the cycle	-	src/schema/errors.ts:139
name	public	string	-	SchemaValidationError.name	node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1076
message	public	string	-	SchemaValidationError.message	node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1077
stack?	public	string	-	SchemaValidationError.stack	node_modules/.pnpm/typescript@5.8.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@types+node@22.15.17/node_modules/@types/node/globals.d.ts:145

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

SchemaValidationError.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@types+node@22.15.17/node_modules/@types/node/globals.d.ts:149

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

SchemaValidationError.prepareStackTrace