Skip to content

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

Constructors

Constructor

ts
new LeaseHeldError(message, opts?): LeaseHeldError;

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

Parameters

ParameterType
messagestring
opts?{ cause?: unknown; data?: Json; }
opts.cause?unknown
opts.data?Json

Returns

LeaseHeldError

Overrides

RulvarError.constructor

Properties

PropertyModifierTypeDefault valueOverridesInherited fromDefined in
codereadonly"lease_held""lease_held"RulvarError.code-packages/core/dist/index.d.ts
data?readonlyJsonundefined-RulvarError.datapackages/core/dist/index.d.ts
retryablereadonlybooleanundefined-RulvarError.retryablepackages/core/dist/index.d.ts

Methods

toWire()

ts
toWire(): WireError;

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

Returns

WireError

Inherited from

RulvarError.toWire