Type Alias IDatabaseSemaphoreAdapter

Type declaration

• removeAllSlots:function

  • removeAllSlots(key: string): Promise<ISemaphoreSlotExpirationData[]>

  • The removeAllSlots removes all slots of the given semaphore.

    Parameters

    • key: string

    Returns Promise<ISemaphoreSlotExpirationData[]>

    Returns the slot expiration.

• removeSlot:function

  • removeSlot(
        key: string,
        slotId: string,
    ): Promise<null | ISemaphoreSlotExpirationData>

  • The removeSlot removes the specified slot.

    Parameters

    • key: string
    • slotId: string

    Returns Promise<null | ISemaphoreSlotExpirationData>

    Returns the slot expiration.

• transaction:function

  • transaction<TValue>(
        fn: InvokableFn<
            [transaction: IDatabaseSemaphoreTransaction],
            Promise<TValue>,
        >,
    ): Promise<TValue>

  • The transaction method runs the fn function inside a transaction. The fn function is given a IDatabaseSemaphoreTransaction object.

    Note when implementing this method use the strictest transaction level mode.

    Type Parameters

    • TValue

    Parameters

    • fn: InvokableFn<[transaction: IDatabaseSemaphoreTransaction], Promise<TValue>>

    Returns Promise<TValue>

• updateExpiration:function

  • updateExpiration(key: string, slotId: string, expiration: Date): Promise<number>

  • The updateExpiration updates the specified slot expiration as long as it is expireable and unexpired of the given semaphore.

    Parameters

    • key: string
    • slotId: string
    • expiration: Date

    Returns Promise<number>

    Returns a number greater than 0 if the slot expiration was updated, otherwise returns 0.