Class RedisSharedLockAdapter

To utilize the RedisSharedLockAdapter, you must install the "ioredis" package.

Note in order to use RedisSharedLockAdapter correctly, ensure you use a single, consistent database across all server instances.

IMPORT_PATH: "@daiso-tech/core/shared-lock/redis-shared-lock-adapter"

Implements

ISharedLockAdapter

Index

Constructors

constructor

Methods

acquireReader acquireWriter forceRelease forceReleaseAllReaders forceReleaseWriter getState refreshReader refreshWriter releaseReader releaseWriter

Constructors

constructor

new RedisSharedLockAdapter(database: Redis): RedisSharedLockAdapter

Parameters

database: Redis

Returns RedisSharedLockAdapter

Example

import { RedisSharedLockAdapter } from "@daiso-tech/core/shared-lock/redis-shared-lock-adapter";
import Redis from "ioredis";

const database = new Redis("YOUR_REDIS_CONNECTION_STRING");
const sharedLockAdapter = new RedisSharedLockAdapter(database);

Methods

acquireReader

acquireReader(settings: SharedLockAcquireSettings): Promise<boolean>
Attempts to acquire a reader slot in the shared lock. Succeeds only if no non-expired writer lock is held and the current number of acquired reader slots has not reached the limit.
Parameters
- settings: SharedLockAcquireSettings
  Settings containing the context, key, lockId, limit, and ttl for the acquisition
Returns Promise<boolean>
Promise resolving to true if the reader slot was successfully acquired, false if the slot limit has been reached
Implementation of ISharedLockAdapter.acquireReader
- Defined in src/shared-lock/implementations/adapters/redis-shared-lock-adapter/redis-shared-lock-adapter.ts:783

acquireWriter

acquireWriter(
    _context: IReadableContext,
    key: string,
    lockId: string,
    ttl: null | TimeSpan,
): Promise<boolean>
Attempts to acquire a writer lock for the specified key. Succeeds only if no non-expired writer lock exists and no non-expired reader slots are held.
Parameters
- _context: IReadableContext
- key: string
  Unique identifier for the shared lock
- lockId: string
  Unique identifier for this acquirer (becomes the owner)
- ttl: null | TimeSpan
  Time-to-live duration or null for indefinite locks
Returns Promise<boolean>
Promise resolving to true if the writer lock was successfully acquired, false if already held by another owner
Implementation of ISharedLockAdapter.acquireWriter
- Defined in src/shared-lock/implementations/adapters/redis-shared-lock-adapter/redis-shared-lock-adapter.ts:734

forceRelease

forceRelease(_context: IReadableContext, key: string): Promise<boolean>
Forcibly releases both the writer lock and all reader slots regardless of ownership. Used for complete emergency cleanup of the shared lock.
Parameters
- _context: IReadableContext
- key: string
  Unique identifier for the shared lock
Returns Promise<boolean>
Promise resolving to true if the shared lock existed and was fully released, false if the shared lock doesn't exist
Implementation of ISharedLockAdapter.forceRelease
- Defined in src/shared-lock/implementations/adapters/redis-shared-lock-adapter/redis-shared-lock-adapter.ts:835

forceReleaseAllReaders

forceReleaseAllReaders(
_context: IReadableContext,
key: string,
): Promise<boolean>
Forcibly releases all reader slots for the specified shared lock regardless of ownership. Used for emergency cleanup or administrative operations. Bypasses ownership verification for situations where individual slot holders are unavailable.
Parameters
- _context: IReadableContext
- key: string
  Unique identifier for the shared lock
Returns Promise<boolean>
Promise resolving to true if reader slots existed and were released, false if no reader slots are acquired
Implementation of ISharedLockAdapter.forceReleaseAllReaders
- Defined in src/shared-lock/implementations/adapters/redis-shared-lock-adapter/redis-shared-lock-adapter.ts:823

forceReleaseWriter

forceReleaseWriter(_context: IReadableContext, key: string): Promise<boolean>
Forcibly releases a writer lock regardless of ownership. Used for emergency lock release or administrative cleanup. Bypasses ownership verification for situations where the owner is unavailable.
Parameters
- _context: IReadableContext
- key: string
  Unique identifier for the shared lock
Returns Promise<boolean>
Promise resolving to true if the writer lock existed and was released, false if the lock is already expired
Implementation of ISharedLockAdapter.forceReleaseWriter
- Defined in src/shared-lock/implementations/adapters/redis-shared-lock-adapter/redis-shared-lock-adapter.ts:774

getState

getState(
_context: IReadableContext,
key: string,
): Promise<null | ISharedLockAdapterState>
Retrieves the current state of a shared lock.
Parameters
- _context: IReadableContext
- key: string
  Unique identifier for the shared lock
Returns Promise<null | ISharedLockAdapterState>
Promise resolving to the non-expired shared lock state if it exists; otherwise null for missing or expired shared locks
Implementation of ISharedLockAdapter.getState
- Defined in src/shared-lock/implementations/adapters/redis-shared-lock-adapter/redis-shared-lock-adapter.ts:846

refreshReader

refreshReader(
    _context: IReadableContext,
    key: string,
    lockId: string,
    ttl: TimeSpan,
): Promise<boolean>
Refreshes (extends) the time-to-live of an existing reader slot. Only succeeds if all conditions are met: the slot exists, hasn't expired, and is expirable.
Parameters
- _context: IReadableContext
- key: string
  Unique identifier for the shared lock
- lockId: string
- ttl: TimeSpan
  New time-to-live duration to set
Returns Promise<boolean>
Promise resolving to true if refresh succeeded, false if the slot is unexpirable, expired, or doesn't exist
Implementation of ISharedLockAdapter.refreshReader
- Defined in src/shared-lock/implementations/adapters/redis-shared-lock-adapter/redis-shared-lock-adapter.ts:808

refreshWriter

refreshWriter(
    _context: IReadableContext,
    key: string,
    lockId: string,
    ttl: TimeSpan,
): Promise<boolean>
Refreshes (extends) the time-to-live of an existing writer lock. Only succeeds if all conditions are met: ownership matches, lock hasn't expired, and it's expirable.
Parameters
- _context: IReadableContext
- key: string
  Unique identifier for the shared lock
- lockId: string
  Unique identifier of the lock owner
- ttl: TimeSpan
  New time-to-live duration to set
Returns Promise<boolean>
Promise resolving to true if refresh succeeded, false if the lock is unexpirable, expired, or not owned by lockId
Implementation of ISharedLockAdapter.refreshWriter
- Defined in src/shared-lock/implementations/adapters/redis-shared-lock-adapter/redis-shared-lock-adapter.ts:760

releaseReader

releaseReader(
    _context: IReadableContext,
    key: string,
    lockId: string,
): Promise<boolean>
Releases a specific reader slot if it is currently acquired. Only the holder of the slot (identified by slotId) can release it.
Parameters
- _context: IReadableContext
- key: string
  Unique identifier for the shared lock
- lockId: string
Returns Promise<boolean>
Promise resolving to true if the reader slot was successfully released, false if the slot doesn't exist or is already released
Implementation of ISharedLockAdapter.releaseReader
- Defined in src/shared-lock/implementations/adapters/redis-shared-lock-adapter/redis-shared-lock-adapter.ts:795

releaseWriter

releaseWriter(
    _context: IReadableContext,
    key: string,
    lockId: string,
): Promise<boolean>
Releases a writer lock if owned by the specified lockId. Ownership verification prevents accidental release of locks held by others.
Parameters
- _context: IReadableContext
- key: string
  Unique identifier for the shared lock
- lockId: string
  Unique identifier of the lock owner
Returns Promise<boolean>
Promise resolving to true if the writer lock was successfully released, false if not owned by lockId or doesn't exist
Implementation of ISharedLockAdapter.releaseWriter
- Defined in src/shared-lock/implementations/adapters/redis-shared-lock-adapter/redis-shared-lock-adapter.ts:748

Class RedisSharedLockAdapter

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns RedisSharedLockAdapter

Example

Methods

acquireReader

Parameters

Returns Promise<boolean>

acquireWriter

Parameters

Returns Promise<boolean>

forceRelease

Parameters

Returns Promise<boolean>

forceReleaseAllReaders

Parameters

Returns Promise<boolean>

forceReleaseWriter

Parameters

Returns Promise<boolean>

getState

Parameters

Returns Promise<null | ISharedLockAdapterState>

refreshReader

Parameters

Returns Promise<boolean>

refreshWriter

Parameters

Returns Promise<boolean>

releaseReader

Parameters

Returns Promise<boolean>

releaseWriter

Parameters

Returns Promise<boolean>

Settings

On This Page