Class NoOpLockAdapter

The NoOpLockAdapter will do nothing and is used for easily mocking ILockFactory for testing.

IMPORT_PATH: "@daiso-tech/core/lock/no-op-lock-adapter"

Implements

ILockAdapter

Index

Constructors

Methods

acquire forceRelease getState refresh release

Constructors

constructor

new NoOpLockAdapter(): NoOpLockAdapter
Returns NoOpLockAdapter

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
- _lockId: string
- _ttl: null | TimeSpan
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/no-op-lock-adapter/no-op-lock-adapter.ts:21

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
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/no-op-lock-adapter/no-op-lock-adapter.ts:38

getState

getState(
_context: IReadableContext,
_key: string,
): Promise<null | ILockAdapterState>
Retrieves the current state of a lock.
Parameters
- _context: IReadableContext
- _key: string
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/no-op-lock-adapter/no-op-lock-adapter.ts:51

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
- _lockId: string
- _ttl: TimeSpan
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/no-op-lock-adapter/no-op-lock-adapter.ts:42

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
- _lockId: string
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/no-op-lock-adapter/no-op-lock-adapter.ts:30