Skip to content

Rulvar API reference


Rulvar API reference / @rulvar/executor / LedgerCorruptionError

Class: LedgerCorruptionError

Defined in: packages/executor/src/ledger.ts:261

The fail-closed refusal of loadEffectLedger (RV502, widened by RV607): the file holds at least one line the scan cannot admit, unparseable bytes on an interior line, invalid UTF-8, a JSON value that is not an object, a missing or mistyped required field, or an unknown phase, none of which the writer's tail repair can produce, so it means external damage or a foreign writer, never a normal crash artifact. Reconciling from a partial scan would silently drop intents; triage the named lines instead (tolerateCorrupt: true surfaces them as data).

Extends

  • Error

Constructors

Constructor

ts
new LedgerCorruptionError(path, lines): LedgerCorruptionError;

Defined in: packages/executor/src/ledger.ts:263

Parameters

ParameterType
pathstring
linesCorruptLedgerLine[]

Returns

LedgerCorruptionError

Overrides

ts
Error.constructor

Properties

PropertyModifierTypeDescriptionInherited fromDefined in
cause?publicunknown-Error.causenode_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:24
linesreadonlyCorruptLedgerLine[]--packages/executor/src/ledger.ts:262
messagepublicstring-Error.messagenode_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1075
namepublicstring-Error.namenode_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1074
stack?publicstring-Error.stacknode_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1076
stackTraceLimitstaticnumberThe 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.Error.stackTraceLimitnode_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:68

Methods

captureStackTrace()

ts
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.

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

ParameterType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

ts
Error.captureStackTrace

prepareStackTrace()

ts
static prepareStackTrace(err, stackTraces): any;

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

Parameters

ParameterType
errError
stackTracesCallSite[]

Returns

any

See

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

Inherited from

ts
Error.prepareStackTrace