Skip to content

dag-core / Exports / ILeasePort

Interface: ILeasePort

Port for distributed lease management: acquire, renew, release, and query.

Table of contents

Methods

Methods

acquire

acquire(leaseKey, ownerId, leaseDurationMs): Promise<undefined | ILeaseRecord>

Parameters

NameType
leaseKeystring
ownerIdstring
leaseDurationMsnumber

Returns

Promise<undefined | ILeaseRecord>

Defined in

interfaces/ports.ts:74


renew

renew(leaseKey, ownerId, leaseDurationMs): Promise<undefined | ILeaseRecord>

Parameters

NameType
leaseKeystring
ownerIdstring
leaseDurationMsnumber

Returns

Promise<undefined | ILeaseRecord>

Defined in

interfaces/ports.ts:75


release

release(leaseKey, ownerId): Promise<void>

Parameters

NameType
leaseKeystring
ownerIdstring

Returns

Promise<void>

Defined in

interfaces/ports.ts:76


get

get(leaseKey): Promise<undefined | ILeaseRecord>

Parameters

NameType
leaseKeystring

Returns

Promise<undefined | ILeaseRecord>

Defined in

interfaces/ports.ts:77

Released under the MIT License.