rulvar API reference

---

rulvar API reference / @rulvar/core / RulvarError

Abstract Class: RulvarError

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

Base class for all engine-raised errors. "Retryable" means the engine's own retry machinery (RetryPolicy under the journal) MAY retry; it never means a provider SDK autoretry, which is disabled.

Extends

• Error

Extended by

• ConfigError
• NonSerializableValueError
• ScriptRejected
• JournalCompatibilityError
• InvalidResolutionError
• JournalOrderViolation
• PlanInvariantError
• ReplayPlanHashMismatch
• OrchestratorCapConfigError
• JournalMissError
• BudgetExhaustedError
• AdmissionRejectedError
• SandboxError
• LeaseHeldError
• KnowledgeCasError

Constructors

Constructor

new RulvarError(message, opts?): RulvarError;

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

Parameters

Parameter	Type
message	string
opts?	{ cause?: unknown; data?: Json; retryable?: boolean; }
opts.cause?	unknown
opts.data?	Json
opts.retryable?	boolean

Returns

RulvarError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
cause?	public	unknown	-	Error.cause	node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:24
code	abstract	ErrorCode	-	-	packages/core/src/l0/errors.ts:55
data?	readonly	Json	-	-	packages/core/src/l0/errors.ts:57
message	public	string	-	Error.message	node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1075
name	public	string	-	Error.name	node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1074
retryable	readonly	boolean	-	-	packages/core/src/l0/errors.ts:56
stack?	public	string	-	Error.stack	node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1076
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.	Error.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

---

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

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

Error.prepareStackTrace