Type Alias ISemaphoreBase

Type declaration

• acquire:function

  • acquire(): LazyPromise<boolean>

  • The acquire method acquires an slots only if the slot limit is not reached.

    Returns LazyPromise<boolean>

    Returns true if the slot limit is not reached otherwise false is returned.

• acquireBlocking:function

  • acquireBlocking(
        settings?: SemaphoreAquireBlockingSettings,
    ): LazyPromise<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 LazyPromise<boolean>

    Returns true if the slot limit is not reached otherwise false is returned.

• acquireBlockingOrFail:function

  • acquireBlockingOrFail(
        settings?: SemaphoreAquireBlockingSettings,
    ): LazyPromise<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 LazyPromise<void>

    Throws

    LimitReachedSemaphoreError

• acquireOrFail:function

  • acquireOrFail(): LazyPromise<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 LazyPromise<void>

    Throws

    LimitReachedSemaphoreError

• forceReleaseAll:function

  • forceReleaseAll(): LazyPromise<boolean>

  • The forceReleaseAll method releases the all slots.

    Returns LazyPromise<boolean>

    Returns true if the semaphore exists and has at least one unavailable slot or false if all slots are available.

• refresh:function

  • refresh(ttl?: ITimeSpan): LazyPromise<boolean>

  • The refresh method updates the ttl of the slot when acquired.

    Parameters

    • Optionalttl: ITimeSpan

    Returns LazyPromise<boolean>

    Returns true if the slot is refreshed otherwise false is returned.

• refreshOrFail:function

  • refreshOrFail(ttl?: ITimeSpan): LazyPromise<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 LazyPromise<void>

    Throws

    FailedRefreshSemaphoreError

• release:function

  • release(): LazyPromise<boolean>

  • The release method releases the current slot.

    Returns LazyPromise<boolean>

    Returns true if the semaphore exists and has at least one busy slot or false.

• releaseOrFail:function

  • releaseOrFail(): LazyPromise<void>

  • The releaseOrFail method releases the current slot. Throws an error if the slot is not acquired.

    Returns LazyPromise<void>

    Throws

    FailedReleaseSemaphoreError

• run:function

  • run<TValue = void>(
        asyncFn: AsyncLazy<TValue>,
    ): LazyPromise<Result<TValue, LimitReachedSemaphoreError>>

  • The run method wraps an Invokable | Invokable or LazyPromise with the acquire and release method.

    Type Parameters

    • TValue = void

    Parameters

    • asyncFn: AsyncLazy<TValue>

    Returns LazyPromise<Result<TValue, LimitReachedSemaphoreError>>

• runBlocking:function

  • runBlocking<TValue = void>(
        asyncFn: AsyncLazy<TValue>,
        settings?: SemaphoreAquireBlockingSettings,
    ): LazyPromise<Result<TValue, LimitReachedSemaphoreError>>

  • The runBlocking method wraps an Invokable | Invokable or LazyPromise with the acquireBlocking and release method.

    Type Parameters

    • TValue = void

    Parameters

    • asyncFn: AsyncLazy<TValue>
    • Optionalsettings: SemaphoreAquireBlockingSettings

    Returns LazyPromise<Result<TValue, LimitReachedSemaphoreError>>

• runBlockingOrFail:function

  • runBlockingOrFail<TValue = void>(
        asyncFn: AsyncLazy<TValue>,
        settings?: SemaphoreAquireBlockingSettings,
    ): LazyPromise<TValue>

  • The runBlockingOrFail method wraps an Invokable | Invokable or LazyPromise with the acquireBlockingOrFail and release method.

    Type Parameters

    • TValue = void

    Parameters

    • asyncFn: AsyncLazy<TValue>
    • Optionalsettings: SemaphoreAquireBlockingSettings

    Returns LazyPromise<TValue>

    Throws

    LimitReachedSemaphoreError

• runOrFail:function

  • runOrFail<TValue = void>(asyncFn: AsyncLazy<TValue>): LazyPromise<TValue>

  • The runOrFail method wraps an Invokable | Invokable or LazyPromise with the acquireOrFail and release method.

    Type Parameters

    • TValue = void

    Parameters

    • asyncFn: AsyncLazy<TValue>

    Returns LazyPromise<TValue>

    Throws

    LimitReachedSemaphoreError