Class SimpleLock

Simple lock implementation for single Redis instance Provides reliable locking with retry logic and proper error handling Memory-optimized for production 24/7 systems

Implements

Lock

Index

Constructors

constructor

Methods

acquire extend getAdapter getConfig getHealth isLocked release using

Constructors

constructor

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

Methods

acquire

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

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

extend

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

getAdapter

getAdapter(): RedisAdapter | null
Get the underlying Redis adapter (for advanced usage)

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

getConfig

getConfig(): Readonly<SimpleLockConfig>
Get lock configuration (for debugging)

Returns Readonly<SimpleLockConfig>
- Defined in src/locks/SimpleLock.ts:392

getHealth

getHealth(): {
    circuitBreaker: {
        failures: number;
        openedAt: number;
        state: "closed"
        | "open"
        | "half-open";
    };
    connected: boolean;
    healthy: boolean;
    lastCheck: number;
}
Get connection health status

Returns {
    circuitBreaker: {
        failures: number;
        openedAt: number;
        state: "closed" | "open" | "half-open";
    };
    connected: boolean;
    healthy: boolean;
    lastCheck: number;
}
- Defined in src/locks/SimpleLock.ts:416

isLocked

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

release

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

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/SimpleLock.ts:446

Class SimpleLock

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SimpleLock

Methods

acquire

Returns Promise<LockHandle>

extend

Parameters

Returns Promise<boolean>

getAdapter

Returns RedisAdapter | null

getConfig

Returns Readonly<SimpleLockConfig>

getHealth

Returns {
    circuitBreaker: {
        failures: number;
        openedAt: number;
        state: "closed" | "open" | "half-open";
    };
    connected: boolean;
    healthy: boolean;
    lastCheck: number;
}

isLocked

Parameters

Returns Promise<boolean>

release

Parameters

Returns Promise<boolean>

using

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page

Class SimpleLock

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SimpleLock

Methods

acquire

Returns Promise<LockHandle>

extend

Parameters

Returns Promise<boolean>

getAdapter

Returns RedisAdapter | null

getConfig

Returns Readonly<SimpleLockConfig>

getHealth

Returns { circuitBreaker: { failures: number; openedAt: number; state: "closed" | "open" | "half-open"; }; connected: boolean; healthy: boolean; lastCheck: number;}

isLocked

Parameters

Returns Promise<boolean>

release

Parameters

Returns Promise<boolean>

using

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page

Returns {
circuitBreaker: {
failures: number;
openedAt: number;
state: "closed" | "open" | "half-open";
};
connected: boolean;
healthy: boolean;
lastCheck: number;
}