rulvar API reference

---

rulvar API reference / @rulvar/rulvar / LeaseHeldError

Class: LeaseHeldError

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

acquire() on a currently held lease. Retryable by contract: retry after the lease ttl elapses or the holder releases.

Extends

• RulvarError

Constructors

Constructor

new LeaseHeldError(message, opts?): LeaseHeldError;

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

Parameters

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

Returns

LeaseHeldError

Overrides

RulvarError.constructor

Properties

Property	Modifier	Type	Default value	Description	Overrides	Inherited from	Defined in
cause?	public	unknown	undefined	-	-	RulvarError.cause	node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:24
code	readonly	"lease_held"	"lease_held"	-	RulvarError.code	-	packages/core/dist/index.d.ts
data?	readonly	Json	undefined	-	-	RulvarError.data	packages/core/dist/index.d.ts
message	public	string	undefined	-	-	RulvarError.message	node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1075
name	public	string	undefined	-	-	RulvarError.name	node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1074
retryable	readonly	boolean	undefined	-	-	RulvarError.retryable	packages/core/dist/index.d.ts
stack?	public	string	undefined	-	-	RulvarError.stack	node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1076
stackTraceLimit	static	number	undefined	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/dist/index.d.ts

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