API reference › @evolu/common › Resource › ClaimLease

Defined in: packages/common/src/Resource.ts:1088

An owned lease on the resource-retains added by one claim operation.

A ClaimLease is a grouped ownership token. For example, a claim for one account can retain its relay, local-network, and Bluetooth transports. The ClaimLease releases that whole group together; it does not expose or transfer ownership of the resources themselves.

Releasing the lease removes every retain added by that claim call. Release is idempotent and synchronous; resource disposal remains owned by the SharedResourceByKeyWithClaims that created the lease.

Extends

• Disposable

Methods

[dispose]()

dispose: void;

Defined in: node_modules/@typescript/old/lib/lib.esnext.disposable.d.ts:34

Inherited from

Disposable.[dispose]

Properties

release

readonly release: () => boolean;

Defined in: packages/common/src/Resource.ts:1096

Releases every resource retain owned by this claim lease.

Returns whether this call released a still-held lease. Returns false if the lease was already released or drained by disposal of its owning SharedResourceByKeyWithClaims or the Run tree that owns it.