Skip to content

Rulvar API reference


Rulvar API reference / @rulvar/rulvar / JournalCompatibilityError

Class: JournalCompatibilityError

Defined in: packages/core/dist/index.d.ts

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

Constructors

Constructor

ts
new JournalCompatibilityError(message, detail): JournalCompatibilityError;

Defined in: packages/core/dist/index.d.ts

Parameters

ParameterType
messagestring
detail{ entryHashVersion: number; entrySeq: number; hint: string; runId: string; subCode: JournalCompatSubCode; supportedRange: { max: number; min: number; }; }
detail.entryHashVersionnumber
detail.entrySeqnumber
detail.hintstring
detail.runIdstring
detail.subCodeJournalCompatSubCode
detail.supportedRange{ max: number; min: number; }
detail.supportedRange.maxnumber
detail.supportedRange.minnumber

Returns

JournalCompatibilityError

Overrides

RulvarError.constructor

Properties

PropertyModifierTypeDefault valueDescriptionOverridesInherited fromDefined in
codereadonly"journal_compat""journal_compat"-RulvarError.code-packages/core/dist/index.d.ts
data?readonlyJsonundefined--RulvarError.datapackages/core/dist/index.d.ts
entryHashVersionreadonlynumberundefined---packages/core/dist/index.d.ts
entrySeqreadonlynumberundefinedSeq of the first violating entry.--packages/core/dist/index.d.ts
hintreadonlystringundefined'enable deriverV1 from @rulvar/compat' or 'upgrade rulvar'.--packages/core/dist/index.d.ts
retryablereadonlybooleanundefined--RulvarError.retryablepackages/core/dist/index.d.ts
runIdreadonlystringundefined---packages/core/dist/index.d.ts
subCodereadonlyJournalCompatSubCodeundefined---packages/core/dist/index.d.ts
supportedRangereadonly{ max: number; min: number; }undefined---packages/core/dist/index.d.ts
supportedRange.maxpublicnumberundefined---packages/core/dist/index.d.ts
supportedRange.minpublicnumberundefined---packages/core/dist/index.d.ts

Methods

toWire()

ts
toWire(): WireError;

Defined in: packages/core/dist/index.d.ts

Returns

WireError

Inherited from

RulvarError.toWire