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 getState refresh release

Constructors

constructor

new NoOpLockAdapter(): NoOpLockAdapter
Returns NoOpLockAdapter

Methods

acquire

acquire(_key: string, _lockId: string, _ttl: null | TimeSpan): Promise<boolean>
The acquire method acquires a lock only if expired.
Parameters
- _key: string
- _lockId: string
- _ttl: null | TimeSpan
Returns Promise<boolean>
Returns true if expired otherwise false is returned.
Implementation of ILockAdapter.acquire
- Defined in src/lock/implementations/adapters/no-op-lock-adapter/no-op-lock-adapter.ts:20

forceRelease

forceRelease(_key: string): Promise<boolean>
The forceRelease method releases a lock regardless of the owner.
Parameters
- _key: string
Returns Promise<boolean>
Returns true if the lock exists or false if the lock is expired.
Implementation of ILockAdapter.forceRelease
- Defined in src/lock/implementations/adapters/no-op-lock-adapter/no-op-lock-adapter.ts:32

getState

getState(_key: string): Promise<null | ILockAdapterState>
Parameters
- _key: string
Returns Promise<null | ILockAdapterState>
Implementation of ILockAdapter.getState
- Defined in src/lock/implementations/adapters/no-op-lock-adapter/no-op-lock-adapter.ts:40

refresh

refresh(_key: string, _lockId: string, _ttl: TimeSpan): Promise<boolean>
The refresh method will upadte ttl of lock if it matches the owner and is expireable.
Parameters
- _key: string
- _lockId: string
- _ttl: TimeSpan
Returns Promise<boolean>
Returns false if the lock is unexpireable, the is expired, does not match the owner otherwise true is returned.
Implementation of ILockAdapter.refresh
- Defined in src/lock/implementations/adapters/no-op-lock-adapter/no-op-lock-adapter.ts:36

release

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