Class NoOpSharedLockAdapter

This NoOpSharedLockAdapter will do nothing and is used for easily mocking ISharedLockProvider for testing.

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

Implements

ISharedLockAdapter

Index

Constructors

Methods

acquireReader acquireWriter forceRelease forceReleaseAllReaders forceReleaseWriter getState refreshReader refreshWriter releaseReader releaseWriter

Constructors

constructor

new NoOpSharedLockAdapter(): NoOpSharedLockAdapter
Returns NoOpSharedLockAdapter

Methods

acquireReader

acquireReader(_settings: SharedLockAcquireSettings): Promise<boolean>
The acquireReader method acquires a slot only if the slot limit is not reached.
Parameters
- _settings: SharedLockAcquireSettings
Returns Promise<boolean>
Returns true if the slot limit is not reached otherwise false is returned.
Implementation of ISharedLockAdapter.acquireReader
- Defined in src/shared-lock/implementations/adapters/no-op-shared-lock-adapter/no-op-shared-lock-adapter.ts:45

acquireWriter

acquireWriter(
    _key: string,
    _lockId: string,
    _ttl: null | TimeSpan,
): Promise<boolean>
The acquireWriter 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 ISharedLockAdapter.acquireWriter
- Defined in src/shared-lock/implementations/adapters/no-op-shared-lock-adapter/no-op-shared-lock-adapter.ts:21

forceRelease

forceRelease(_key: string): Promise<boolean>
Parameters
- _key: string
Returns Promise<boolean>
Implementation of ISharedLockAdapter.forceRelease
- Defined in src/shared-lock/implementations/adapters/no-op-shared-lock-adapter/no-op-shared-lock-adapter.ts:65

forceReleaseAllReaders

forceReleaseAllReaders(_key: string): Promise<boolean>
The forceReleaseAllReaders method releases all slots related to the key.
Parameters
- _key: string
Returns Promise<boolean>
Implementation of ISharedLockAdapter.forceReleaseAllReaders
- Defined in src/shared-lock/implementations/adapters/no-op-shared-lock-adapter/no-op-shared-lock-adapter.ts:53

forceReleaseWriter

forceReleaseWriter(_key: string): Promise<boolean>
The forceReleaseWriter 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 ISharedLockAdapter.forceReleaseWriter
- Defined in src/shared-lock/implementations/adapters/no-op-shared-lock-adapter/no-op-shared-lock-adapter.ts:33

getState

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

refreshReader

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

refreshWriter

refreshWriter(_key: string, _lockId: string, _ttl: TimeSpan): Promise<boolean>
The refreshWriter 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 ISharedLockAdapter.refreshWriter
- Defined in src/shared-lock/implementations/adapters/no-op-shared-lock-adapter/no-op-shared-lock-adapter.ts:37

releaseReader

releaseReader(_key: string, _lockId: string): Promise<boolean>
The releaseReader method releases given slot related to the key.
Parameters
- _key: string
- _lockId: 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 ISharedLockAdapter.releaseReader
- Defined in src/shared-lock/implementations/adapters/no-op-shared-lock-adapter/no-op-shared-lock-adapter.ts:49

releaseWriter

releaseWriter(_key: string, _lockId: string): Promise<boolean>
The releaseWriter 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 ISharedLockAdapter.releaseWriter
- Defined in src/shared-lock/implementations/adapters/no-op-shared-lock-adapter/no-op-shared-lock-adapter.ts:29

Class NoOpSharedLockAdapter

Implements

Index

Constructors

Methods

Constructors

constructor

Returns NoOpSharedLockAdapter

Methods

acquireReader

Parameters

Returns Promise<boolean>

acquireWriter

Parameters

Returns Promise<boolean>

forceRelease

Parameters

Returns Promise<boolean>

forceReleaseAllReaders

Parameters

Returns Promise<boolean>

forceReleaseWriter

Parameters

Returns Promise<boolean>

getState

Parameters

Returns Promise<null | ISharedLockAdapterState>

refreshReader

Parameters

Returns Promise<boolean>

refreshWriter

Parameters

Returns Promise<boolean>

releaseReader

Parameters

Returns Promise<boolean>

releaseWriter

Parameters

Returns Promise<boolean>

Settings

On This Page