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.
Implements
Section titled âImplementsâConstructors
Section titled âConstructorsâConstructor
Section titled âConstructorânew RedisLeaderLock(
options):RedisLeaderLock
Defined in: packages/sharding/src/leader.ts:46
Parameters
Section titled âParametersâoptions
Section titled âoptionsâReturns
Section titled âReturnsâRedisLeaderLock
Methods
Section titled âMethodsâacquire()
Section titled âacquire()â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â.
Parameters
Section titled âParametersânumber
Returns
Section titled âReturnsâPromise<boolean>
Implementation of
Section titled âImplementation ofârelease()
Section titled ârelease()ârelease():
Promise<void>
Defined in: packages/sharding/src/leader.ts:69
Gives the lock up if this process holds it.
Returns
Section titled âReturnsâPromise<void>