Type Alias ISemaphoreAdapter

Type declaration

• acquire:function

  • 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.

• forceReleaseAll:function

  • forceReleaseAll(key: string): Promise<boolean>

  • The forceReleaseAll method releases all slots related to the key.

    Parameters

    • key: string

    Returns Promise<boolean>

• getState:function

  • 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.

• refresh:function

  • 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.

• release:function

  • 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.