Class LeanSimpleLock

Lean SimpleLock - Optimized for memory efficiency

Memory optimizations:

No circuit breaker by default (saves ~100KB)
No health checks by default (saves ~50KB)
Pre-allocated error objects (saves stack trace overhead)
Minimal property storage with short names
No closures or callbacks
Inline value generation

Implements

Lock

Index

Constructors

Methods

acquire extend getAdapter isLocked release using

Constructors

constructor

new LeanSimpleLock(config: SimpleLockConfig): LeanSimpleLock
Parameters
- config: SimpleLockConfig
Returns LeanSimpleLock
- Defined in src/locks/LeanSimpleLock.ts:39

Methods

acquire

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

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

Throws
LockAcquisitionError on failure
Implementation of Lock.acquire
- Defined in src/locks/LeanSimpleLock.ts:47

extend

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

getAdapter

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

Returns RedisAdapter
Redis adapter instance
Implementation of Lock.getAdapter
- Defined in src/locks/LeanSimpleLock.ts:126

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
Implementation of Lock.isLocked
- Defined in src/locks/LeanSimpleLock.ts:113

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
Implementation of Lock.release
- Defined in src/locks/LeanSimpleLock.ts:89

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 AbortSignal when extension fails
Type Parameters
- T
Parameters
- routine: (signal: ExtendedAbortSignal) => Promise<T>
  Function to execute while holding the lock
Returns Promise<T>
Result of the routine
Implementation of Lock.using
- Defined in src/locks/LeanSimpleLock.ts:138