Skip to content

RedisLeaderLock

Defined in: packages/sharding/src/leader.ts:41

A LeaderLock on one Redis key, with an expiry so a dead leader’s lock lapses on its own.

new RedisLeaderLock(options): RedisLeaderLock

Defined in: packages/sharding/src/leader.ts:46

RedisLeaderLockOptions

RedisLeaderLock

acquire(ttlMs): Promise<boolean>

Defined in: packages/sharding/src/leader.ts:56

Takes the lock for ttlMs, or extends it when this process already holds it. Resolves true while this process is the leader, false when another one holds it. A rejection counts as “unknown”.

number

Promise<boolean>

LeaderLock.acquire


release(): Promise<void>

Defined in: packages/sharding/src/leader.ts:69

Gives the lock up if this process holds it.

Promise<void>

LeaderLock.release