Class RedLock

RedLock implementation for distributed Redis instances Provides reliability across multiple Redis nodes using quorum consensus

Implements

Lock

Index

Constructors

Methods

acquire extend getAdapter getAdapters getConfig getQuorum isLocked release using

Constructors

constructor

new RedLock(config: RedLockConfig): RedLock
Parameters
- config: RedLockConfig
Returns RedLock
- Defined in src/locks/RedLock.ts:46

Methods

acquire

acquire(): Promise<LockHandle>
Attempt to acquire the distributed lock using Redlock algorithm

Returns Promise<LockHandle>
Implementation of Lock.acquire
- Defined in src/locks/RedLock.ts:101

extend

extend(handle: LockHandle, ttl: number): Promise<boolean>
Extend the TTL of an existing distributed lock
Parameters
- handle: LockHandle
- ttl: number
Returns Promise<boolean>
Implementation of Lock.extend
- Defined in src/locks/RedLock.ts:293

getAdapter

getAdapter(): RedisAdapter | null
Get the underlying Redis adapter for atomic operations RedLock manages multiple adapters, so returns null

Returns RedisAdapter | null
Implementation of Lock.getAdapter
- Defined in src/locks/RedLock.ts:399

getAdapters

getAdapters(): readonly RedisAdapter[]
Get all underlying Redis adapters (for advanced usage)

Returns readonly RedisAdapter[]
- Defined in src/locks/RedLock.ts:391

getConfig

getConfig(): Readonly<RedLockConfig>
Get RedLock configuration (for debugging)

Returns Readonly<RedLockConfig>
- Defined in src/locks/RedLock.ts:384

getQuorum

getQuorum(): number
Get quorum requirement

Returns number
- Defined in src/locks/RedLock.ts:406

isLocked

isLocked(key: string): Promise<boolean>
Check if the distributed lock is currently held
Parameters
- key: string
Returns Promise<boolean>
Implementation of Lock.isLocked
- Defined in src/locks/RedLock.ts:339

release

release(handle: LockHandle): Promise<boolean>
Release a previously acquired distributed lock
Parameters
- handle: LockHandle
Returns Promise<boolean>
Implementation of Lock.release
- Defined in src/locks/RedLock.ts:265

using

using<T>(routine: (signal: ExtendedAbortSignal) => Promise<T>): Promise<T>
Execute a routine with automatic lock management and extension Auto-extends when remaining TTL < 20% (extends at ~80% consumed) Uses quorum-based extension strategy (continues if majority of nodes succeed) Provides AbortSignal when extension fails
Type Parameters
- T
Parameters
- routine: (signal: ExtendedAbortSignal) => Promise<T>
Returns Promise<T>
Implementation of Lock.using
- Defined in src/locks/RedLock.ts:416