LeaseOptionsType

LeaseOptionsType = object

Defined in: src/coordination/LeaseOptions.ts:10

Plain options-object shape shared by every Lease backend — the common construction-time options. A plain object of these fields is an accepted alternative to the LeaseOptionsBuilder; concrete backends extend it (e.g. KubernetesLeaseOptionsType).

Extended by

• KubernetesLeaseOptionsType

Properties

acquireRetries?

readonly optional acquireRetries?: number

Defined in: src/coordination/LeaseOptions.ts:20

Max attempts for a single acquire() before returning false.

---

acquireRetryDelayMs?

readonly optional acquireRetryDelayMs?: number

Defined in: src/coordination/LeaseOptions.ts:22

Delay between acquire retries.

---

name

readonly name: string

Defined in: src/coordination/LeaseOptions.ts:12

Lease name — unique identifier within the namespace.

---

owner

readonly owner: string

Defined in: src/coordination/LeaseOptions.ts:14

Identifier of the holder (pod name / host name / uuid).

---

renewalIntervalMs?

readonly optional renewalIntervalMs?: number

Defined in: src/coordination/LeaseOptions.ts:18

How often to renew (< ttlMs — typically ttl/3).

---

ttlMs

readonly ttlMs: number

Defined in: src/coordination/LeaseOptions.ts:16

Time-to-live in ms — the backend auto-expires if we fail to renew.