Interface Lock

Abstract base class for all lock implementations

interface Lock {
    acquire(): Promise<LockHandle>;
    extend(handle: LockHandle, ttl: number): Promise<boolean>;
    getAdapter(): RedisAdapter | null;
    isLocked(key: string): Promise<boolean>;
    release(handle: LockHandle): Promise<boolean>;
    using<T>(routine: (signal: ExtendedAbortSignal) => Promise<T>): Promise<T>;
}

Implemented by

Index

Methods

acquire extend getAdapter isLocked release using

Methods

acquire

acquire(): Promise<LockHandle>
Attempt to acquire the lock

Returns Promise<LockHandle>
Promise resolving to lock handle on success

Throws
LockAcquisitionError on failure
- Defined in src/types/locks.ts:126

extend

extend(handle: LockHandle, ttl: number): Promise<boolean>
Extend the TTL of an existing lock
Parameters
- handle: LockHandle
  Lock handle from acquire()
- ttl: number
  New TTL in milliseconds
Returns Promise<boolean>
Promise resolving to true if extended, false if lock expired
- Defined in src/types/locks.ts:141

getAdapter

getAdapter(): RedisAdapter | null
Get the underlying Redis adapter for atomic operations

Returns RedisAdapter | null
Redis adapter instance or null if not applicable (e.g., for RedLock with multiple adapters)
- Defined in src/types/locks.ts:154

isLocked

isLocked(key: string): Promise<boolean>
Check if a lock is currently held
Parameters
- key: string
  Lock key to check
Returns Promise<boolean>
Promise resolving to true if locked, false otherwise
- Defined in src/types/locks.ts:148

release

release(handle: LockHandle): Promise<boolean>
Release a previously acquired lock
Parameters
- handle: LockHandle
  Lock handle from acquire()
Returns Promise<boolean>
Promise resolving to true if released, false if already expired
- Defined in src/types/locks.ts:133

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) Provides ExtendedAbortSignal when extension fails
Type Parameters
- T
Parameters
- routine: (signal: ExtendedAbortSignal) => Promise<T>
  Function to execute while holding the lock
Returns Promise<T>
Promise resolving to the routine result
- Defined in src/types/locks.ts:164