Type Alias ISemaphoreAdapter

Type declaration

• acquire:function

  • acquire(settings: SemaphoreAcquireSettings): Promise<boolean>

  • Attempts to acquire a slot in the semaphore. Succeeds only if the current number of acquired slots has not reached the limit.

    Parameters

    • settings: SemaphoreAcquireSettings

      Settings containing the context, key, slotId, limit, and ttl for the acquisition

    Returns Promise<boolean>

    Promise resolving to true if the slot was successfully acquired, false if the slot limit has been reached

• forceReleaseAll:function

  • forceReleaseAll(context: IReadableContext, key: string): Promise<boolean>

  • Forcibly releases all slots for the specified semaphore regardless of ownership. Used for emergency cleanup or administrative operations. Bypasses ownership verification for situations where individual slot holders are unavailable.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      Unique identifier for the semaphore

    Returns Promise<boolean>

    Promise resolving to true if the semaphore existed and slots were released, false if the semaphore doesn't exist or has no acquired slots

• getState:function

  • getState(
        context: IReadableContext,
        key: string,
    ): Promise<null | ISemaphoreAdapterState>

  • Retrieves the current state of a semaphore.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      Unique identifier for the semaphore

    Returns Promise<null | ISemaphoreAdapterState>

    Promise resolving to the non-expired semaphore state if it exists; otherwise null for missing or expired semaphores

• refresh:function

  • refresh(
        context: IReadableContext,
        key: string,
        slotId: string,
        ttl: TimeSpan,
    ): Promise<boolean>

  • Refreshes (extends) the time-to-live of an existing slot. Only succeeds if all conditions are met: the slot exists, hasn't expired, and is expirable.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      Unique identifier for the semaphore
    • slotId: string

      Unique identifier of the slot to refresh
    • ttl: TimeSpan

      New time-to-live duration to set

    Returns Promise<boolean>

    Promise resolving to true if refresh succeeded, false if the slot is unexpirable, expired, or doesn't exist

• release:function

  • release(
        context: IReadableContext,
        key: string,
        slotId: string,
    ): Promise<boolean>

  • Releases a specific slot if it is currently acquired. Only the holder of the slot (identified by slotId) can release it.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      Unique identifier for the semaphore
    • slotId: string

      Unique identifier of the slot to release

    Returns Promise<boolean>

    Promise resolving to true if the slot was successfully released, false if the slot doesn't exist or is already released