Class NoOpLockAdapter

This NoOpLockAdapter will do nothing and is used for easily mocking ILockProvider for testing.

IMPORT_PATH: "@daiso-tech/core/lock/adapters"

Implements

ILockAdapter

Index

Constructors

Methods

acquire forceRelease refresh release

Constructors

constructor

new NoOpLockAdapter(): NoOpLockAdapter
Returns NoOpLockAdapter

Methods

acquire

acquire(
    _key: string,
    _owner: string,
    _ttl: null | TimeSpan,
): PromiseLike<boolean>
The acquire method acquires a lock only if the lock is not already acquired. Returns true if not already acquired othewise false is returned.
Parameters
- _key: string
- _owner: string
- _ttl: null | TimeSpan
Returns PromiseLike<boolean>
Implementation of ILockAdapter.acquire
- Defined in src/lock/implementations/adapters/no-op-lock-adapter/no-op-lock-adapter.ts:17

forceRelease

forceRelease(_key: string): PromiseLike<void>
The forceRelease method releases a lock regardless of the owner.
Parameters
- _key: string
Returns PromiseLike<void>
Implementation of ILockAdapter.forceRelease
- Defined in src/lock/implementations/adapters/no-op-lock-adapter/no-op-lock-adapter.ts:29

refresh

refresh(_key: string, _owner: string, _ttl: TimeSpan): PromiseLike<boolean>
The refresh method will upadte ttl of lock if it matches the given key and matches the given owner. Returns true if the update occured otherwise false is returned.
Parameters
- _key: string
- _owner: string
- _ttl: TimeSpan
Returns PromiseLike<boolean>
Implementation of ILockAdapter.refresh
- Defined in src/lock/implementations/adapters/no-op-lock-adapter/no-op-lock-adapter.ts:33

release

release(_key: string, _owner: string): PromiseLike<boolean>
The release method releases a lock if the owner matches. Returns true if released otherwise false is returned.
Parameters
- _key: string
- _owner: string
Returns PromiseLike<boolean>
Implementation of ILockAdapter.release
- Defined in src/lock/implementations/adapters/no-op-lock-adapter/no-op-lock-adapter.ts:25