Type Alias ISemaphoreBase

ISemaphoreBase: {
    acquire(): Task<boolean>;
    acquireBlocking(settings?: SemaphoreAquireBlockingSettings): Task<boolean>;
    acquireBlockingOrFail(
        settings?: SemaphoreAquireBlockingSettings,
    ): Task<void>;
    acquireOrFail(): Task<void>;
    forceReleaseAll(): Task<boolean>;
    refresh(ttl?: ITimeSpan): Task<boolean>;
    refreshOrFail(ttl?: ITimeSpan): Task<void>;
    release(): Task<boolean>;
    releaseOrFail(): Task<void>;
    run<TValue = void>(
        asyncFn: AsyncLazy<TValue>,
    ): Task<Result<TValue, LimitReachedSemaphoreError>>;
    runBlocking<TValue = void>(
        asyncFn: AsyncLazy<TValue>,
        settings?: SemaphoreAquireBlockingSettings,
    ): Task<Result<TValue, LimitReachedSemaphoreError>>;
    runBlockingOrFail<TValue = void>(
        asyncFn: AsyncLazy<TValue>,
        settings?: SemaphoreAquireBlockingSettings,
    ): Task<TValue>;
    runOrFail<TValue = void>(asyncFn: AsyncLazy<TValue>): Task<TValue>;
}

IMPORT_PATH: "@daiso-tech/core/semaphore/contracts"

Type declaration

acquire:function
- acquire(): Task<boolean>
- The acquire method acquires an slots only if the slot limit is not reached.
  
  Returns Task<boolean>
  Returns true if the slot limit is not reached otherwise false is returned.
  - Defined in src/semaphore/contracts/semaphore.contract.ts:99
acquireBlocking:function
- acquireBlocking(settings?: SemaphoreAquireBlockingSettings): Task<boolean>
- The acquireBlocking method acquires an slots only if the slot limit is not reached. If the slot limit is reached, it retries every settings.interval until settings.time is reached.
  Parameters
  - Optionalsettings: SemaphoreAquireBlockingSettings
  Returns Task<boolean>
  Returns true if the slot limit is not reached otherwise false is returned.
  - Defined in src/semaphore/contracts/semaphore.contract.ts:115
acquireBlockingOrFail:function
- acquireBlockingOrFail(settings?: SemaphoreAquireBlockingSettings): Task<void>
- The acquireBlockingOrFail method acquires an slots only if the slot limit is not reached. If the slot limit is reached, it retries every settings.interval until settings.time is reached. Throws an error if the slot limit is reached after the given settings.time.
  Parameters
  - Optionalsettings: SemaphoreAquireBlockingSettings
  Returns Task<void>
  Throws
  LimitReachedSemaphoreError
  - Defined in src/semaphore/contracts/semaphore.contract.ts:124
acquireOrFail:function
- acquireOrFail(): Task<void>
- The acquireOrFail method acquires an slots only if the slot limit is not reached. Throws an error if the slot limit is reached.
  
  Returns Task<void>
  Throws
  LimitReachedSemaphoreError
  - Defined in src/semaphore/contracts/semaphore.contract.ts:107
forceReleaseAll:function
- forceReleaseAll(): Task<boolean>
- The forceReleaseAll method releases the all slots.
  
  Returns Task<boolean>
  Returns true if the semaphore exists and has at least one unavailable slot or false if all slots are available.
  - Defined in src/semaphore/contracts/semaphore.contract.ts:147
refresh:function
- refresh(ttl?: ITimeSpan): Task<boolean>
- The refresh method updates the ttl of the slot when acquired.
  Parameters
  - Optionalttl: ITimeSpan
  Returns Task<boolean>
  Returns true if the slot is refreshed otherwise false is returned.
  - Defined in src/semaphore/contracts/semaphore.contract.ts:154
refreshOrFail:function
- refreshOrFail(ttl?: ITimeSpan): Task<void>
- The refreshOrFail method updates the ttl of the slot when acquired. Throws an error if the slot is not acquired.
  Parameters
  - Optionalttl: ITimeSpan
  Returns Task<void>
  Throws
  FailedRefreshSemaphoreError
  - Defined in src/semaphore/contracts/semaphore.contract.ts:161
release:function
- release(): Task<boolean>
- The release method releases the current slot.
  
  Returns Task<boolean>
  Returns true if the semaphore exists and has at least one busy slot or false.
  - Defined in src/semaphore/contracts/semaphore.contract.ts:133
releaseOrFail:function
- releaseOrFail(): Task<void>
- The releaseOrFail method releases the current slot. Throws an error if the slot is not acquired.
  
  Returns Task<void>
  Throws
  FailedReleaseSemaphoreError
  - Defined in src/semaphore/contracts/semaphore.contract.ts:140
run:function
- run<TValue = void>(
  asyncFn: AsyncLazy<TValue>,
  ): Task<Result<TValue, LimitReachedSemaphoreError>>
- The run method wraps an Invokable or Task with the acquire and release method.
  Type Parameters
  - TValue = void
  Parameters
  - asyncFn: AsyncLazy<TValue>
  Returns Task<Result<TValue, LimitReachedSemaphoreError>>
  - Defined in src/semaphore/contracts/semaphore.contract.ts:67
runBlocking:function
- runBlocking<TValue = void>(
  asyncFn: AsyncLazy<TValue>,
  settings?: SemaphoreAquireBlockingSettings,
  ): Task<Result<TValue, LimitReachedSemaphoreError>>
- The runBlocking method wraps an Invokable or Task with the acquireBlocking and release method.
  Type Parameters
  - TValue = void
  Parameters
  - asyncFn: AsyncLazy<TValue>
  - Optionalsettings: SemaphoreAquireBlockingSettings
  Returns Task<Result<TValue, LimitReachedSemaphoreError>>
  - Defined in src/semaphore/contracts/semaphore.contract.ts:80
runBlockingOrFail:function
- runBlockingOrFail<TValue = void>(
  asyncFn: AsyncLazy<TValue>,
  settings?: SemaphoreAquireBlockingSettings,
  ): Task<TValue>
- The runBlockingOrFail method wraps an Invokable or Task with the acquireBlockingOrFail and release method.
  Type Parameters
  - TValue = void
  Parameters
  - asyncFn: AsyncLazy<TValue>
  - Optionalsettings: SemaphoreAquireBlockingSettings
  Returns Task<TValue>
  Throws
  LimitReachedSemaphoreError
  - Defined in src/semaphore/contracts/semaphore.contract.ts:89
runOrFail:function
- runOrFail<TValue = void>(asyncFn: AsyncLazy<TValue>): Task<TValue>
- The runOrFail method wraps an Invokable or Task with the acquireOrFail and release method.
  Type Parameters
  - TValue = void
  Parameters
  - asyncFn: AsyncLazy<TValue>
  Returns Task<TValue>
  Throws
  LimitReachedSemaphoreError
  - Defined in src/semaphore/contracts/semaphore.contract.ts:75

Type Alias ISemaphoreBase

Type declaration

acquire:function

Returns Task<boolean>

acquireBlocking:function

Parameters

Returns Task<boolean>

acquireBlockingOrFail:function

Parameters

Returns Task<void>

Throws

acquireOrFail:function

Returns Task<void>

Throws

forceReleaseAll:function

Returns Task<boolean>

refresh:function

Parameters

Returns Task<boolean>

refreshOrFail:function

Parameters

Returns Task<void>

Throws

release:function

Returns Task<boolean>

releaseOrFail:function

Returns Task<void>

Throws

run:function

Type Parameters

Parameters

Returns Task<Result<TValue, LimitReachedSemaphoreError>>

runBlocking:function

Type Parameters

Parameters

Returns Task<Result<TValue, LimitReachedSemaphoreError>>

runBlockingOrFail:function

Type Parameters

Parameters

Returns Task<TValue>

Throws

runOrFail:function

Type Parameters

Parameters

Returns Task<TValue>

Throws

Settings