Class MemoryLockAdapter

Note the MemoryLockAdapter is limited to single process usage and cannot be shared across multiple servers or different processes. This adapter is meant for easily fakingILockFactory for testing.

IMPORT_PATH: "@daiso-tech/core/lock/memory-lock-adapter"

Implements

Index

Constructors

constructor

Methods

acquire deInit forceRelease getState refresh release

Constructors

constructor

new MemoryLockAdapter(map?: Map<string, MemoryLockData>): MemoryLockAdapter

Parameters

map: Map<string, MemoryLockData> = ...

Returns MemoryLockAdapter

Example

import { MemoryLockAdapter } from "@daiso-tech/core/lock/memory-lock-adapter";

const lockAdapter = new MemoryLockAdapter();

You can also provide an Map.

Example

import { MemoryLockAdapter } from "@daiso-tech/core/lock/memory-lock-adapter";

const map = new Map<any, any>();
const lockAdapter = new MemoryLockAdapter(map);

Methods

acquire

acquire(
    _context: IReadableContext,
    key: string,
    lockId: string,
    ttl: null | TimeSpan,
): Promise<boolean>
Attempts to acquire a lock for the specified key. Succeeds only if the lock is currently expired or doesn't exist.
Parameters
- _context: IReadableContext
- key: string
  Unique identifier for the 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 lock was successfully acquired, false if already held by another owner
Implementation of ILockAdapter.acquire
- Defined in src/lock/implementations/adapters/memory-lock-adapter/memory-lock-adapter.ts:70

deInit

deInit(): Promise<void>
Removes all in-memory lock data.

Returns Promise<void>
Implementation of IDeinitizable.deInit
- Defined in src/lock/implementations/adapters/memory-lock-adapter/memory-lock-adapter.ts:60

forceRelease

forceRelease(_context: IReadableContext, key: string): Promise<boolean>
Forcibly releases a 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 lock
Returns Promise<boolean>
Promise resolving to true if lock existed and was released, false if lock is already expired
Implementation of ILockAdapter.forceRelease
- Defined in src/lock/implementations/adapters/memory-lock-adapter/memory-lock-adapter.ts:128

getState

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

refresh

refresh(
    _context: IReadableContext,
    key: string,
    lockId: string,
    ttl: TimeSpan,
): Promise<boolean>
Refreshes (extends) the time-to-live of an existing 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 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 lock is unexpirable, expired, or not owned by lockId
Implementation of ILockAdapter.refresh
- Defined in src/lock/implementations/adapters/memory-lock-adapter/memory-lock-adapter.ts:151

release

release(
    _context: IReadableContext,
    key: string,
    lockId: string,
): Promise<boolean>
Releases a 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 lock
- lockId: string
  Unique identifier of the lock owner
Returns Promise<boolean>
Promise resolving to true if lock was successfully released, false if not owned by lockId or doesn't exist
Implementation of ILockAdapter.release
- Defined in src/lock/implementations/adapters/memory-lock-adapter/memory-lock-adapter.ts:103

Class MemoryLockAdapter

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns MemoryLockAdapter

Example

Example

Methods

acquire

Parameters

Returns Promise<boolean>

deInit

Returns Promise<void>

forceRelease

Parameters

Returns Promise<boolean>

getState

Parameters

Returns Promise<null | ILockAdapterState>

refresh

Parameters

Returns Promise<boolean>

release

Parameters

Returns Promise<boolean>

Settings

On This Page