Class NoOpSemaphoreAdapter

The NoOpSemaphoreAdapter will do nothing and is used for easily mocking ISemaphoreProvider for testing.

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

Implements

ISemaphoreAdapter

Index

Constructors

Methods

acquire forceReleaseAll getState refresh release

Constructors

constructor

new NoOpSemaphoreAdapter(): NoOpSemaphoreAdapter
Returns NoOpSemaphoreAdapter

Methods

acquire

acquire(_settings: SemaphoreAcquireSettings): Promise<boolean>
The acquire method acquires a slot only if the slot limit is not reached.
Parameters
- _settings: SemaphoreAcquireSettings
Returns Promise<boolean>
Returns true if the slot limit is not reached otherwise false is returned.
Implementation of ISemaphoreAdapter.acquire
- Defined in src/semaphore/implementations/adapters/no-op-semaphore-adapter/no-op-semaphore-adapter.ts:28

forceReleaseAll

forceReleaseAll(_key: string): Promise<boolean>
The forceReleaseAll method releases all slots related to the key.
Parameters
- _key: string
Returns Promise<boolean>
Implementation of ISemaphoreAdapter.forceReleaseAll
- Defined in src/semaphore/implementations/adapters/no-op-semaphore-adapter/no-op-semaphore-adapter.ts:36

getState

getState(_key: string): Promise<null | ISemaphoreAdapterState>
The getState method returns the state of the semaphore.
Parameters
- _key: string
Returns Promise<null | ISemaphoreAdapterState>
Returns ISemaphoreAdapterState if the semaphore exists in the database or null if doesnt exists.
Implementation of ISemaphoreAdapter.getState
- Defined in src/semaphore/implementations/adapters/no-op-semaphore-adapter/no-op-semaphore-adapter.ts:21

refresh

refresh(_key: string, _slotId: string, _ttl: TimeSpan): Promise<boolean>
The refresh method expiration of slot if not already expired.
Parameters
- _key: string
- _slotId: string
- _ttl: TimeSpan
Returns Promise<boolean>
Returns true if the slot is refreshed* otherwise false is returned.
Implementation of ISemaphoreAdapter.refresh
- Defined in src/semaphore/implementations/adapters/no-op-semaphore-adapter/no-op-semaphore-adapter.ts:40

release

release(_key: string, _slotId: string): Promise<boolean>
The release method releases given slot related to the key.
Parameters
- _key: string
- _slotId: string
Returns Promise<boolean>
Returns true if the semaphore exists and has at least one unavailable slot or false if all slots are available.
Implementation of ISemaphoreAdapter.release
- Defined in src/semaphore/implementations/adapters/no-op-semaphore-adapter/no-op-semaphore-adapter.ts:32