rulvar API reference

---

rulvar API reference / @rulvar/core / JournalCompatibilityError

Class: JournalCompatibilityError

Defined in: packages/core/src/l0/errors.ts:128

Refusal to open a journal whose hashVersion falls outside the engine's support window (producers ship in M2). The registry code is 'journal_compat'; the sub-codes live on subCode and in data.

Extends

• RulvarError

Constructors

Constructor

new JournalCompatibilityError(message, detail): JournalCompatibilityError;

Defined in: packages/core/src/l0/errors.ts:139

Parameters

Parameter	Type
message	string
detail	{ entryHashVersion: number; entrySeq: number; hint: string; runId: string; subCode: JournalCompatSubCode; supportedRange: { max: number; min: number; }; }
detail.entryHashVersion	number
detail.entrySeq	number
detail.hint	string
detail.runId	string
detail.subCode	JournalCompatSubCode
detail.supportedRange	{ max: number; min: number; }
detail.supportedRange.max	number
detail.supportedRange.min	number

Returns

JournalCompatibilityError

Overrides

RulvarError.constructor

Properties

Property	Modifier	Type	Description	Overrides	Inherited from	Defined in
cause?	public	unknown	-	-	RulvarError.cause	node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:24
code	readonly	"journal_compat"	-	RulvarError.code	-	packages/core/src/l0/errors.ts:129
data?	readonly	Json	-	-	RulvarError.data	packages/core/src/l0/errors.ts:57
entryHashVersion	readonly	number	-	-	-	packages/core/src/l0/errors.ts:134
entrySeq	readonly	number	Seq of the first violating entry.	-	-	packages/core/src/l0/errors.ts:133
hint	readonly	string	'enable deriverV1 from @rulvar/compat' or 'upgrade rulvar'.	-	-	packages/core/src/l0/errors.ts:137
message	public	string	-	-	RulvarError.message	node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1075
name	public	string	-	-	RulvarError.name	node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1074
retryable	readonly	boolean	-	-	RulvarError.retryable	packages/core/src/l0/errors.ts:56
runId	readonly	string	-	-	-	packages/core/src/l0/errors.ts:131
stack?	public	string	-	-	RulvarError.stack	node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1076
subCode	readonly	JournalCompatSubCode	-	-	-	packages/core/src/l0/errors.ts:130
supportedRange	readonly	{ max: number; min: number; }	-	-	-	packages/core/src/l0/errors.ts:135
supportedRange.max	public	number	-	-	-	packages/core/src/l0/errors.ts:135
supportedRange.min	public	number	-	-	-	packages/core/src/l0/errors.ts:135
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.	-	RulvarError.stackTraceLimit	node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:68

Methods

toWire()

toWire(): WireError;

Defined in: packages/core/src/l0/errors.ts:68

Returns

WireError

Inherited from

RulvarError.toWire

---

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@[email protected]/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

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

RulvarError.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

RulvarError.prepareStackTrace