Type Alias IDatabaseSemaphoreAdapter

Type declaration

• removeAllSlots:function

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

  • Removes all slots from a semaphore. Used for cleanup or reset operations. Returns expiration info for all removed slots.

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      The semaphore identifier

    Returns Promise<ISemaphoreSlotExpirationData[]>

    Array of expiration info for all removed slots

• removeSlot:function

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

  • Removes a specific slot, making that resource unit available again. Returns the slot's expiration info. Returns null if slot doesn't exist (idempotent - safe to call multiple times).

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      The semaphore identifier
    • slotId: string

      The slot to remove

    Returns Promise<null | ISemaphoreSlotExpirationData>

    Expiration info of the removed slot, or null if not found

• transaction:function

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

  • Executes a function within a database transaction. Ensures all operations in the function are atomic and isolated.

    Implementations must use the strictest transaction isolation level available (SERIALIZABLE for SQL, highest for document databases) to prevent race conditions.

    Type Parameters

    • TValue

      Return type of the transaction function

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • fn: InvokableFn<[transaction: IDatabaseSemaphoreTransaction], Promise<TValue>>

      Async function receiving transaction object, returns value of any type

    Returns Promise<TValue>

    The value returned by the function

    Throws

    Error if transaction fails or is rolled back

• updateExpiration:function

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

  • Updates a slot's expiration time if it's currently valid (not expired). Useful for extending a held slot's lifetime (e.g., heartbeat/keep-alive).

    Conditions for success:

    • Slot must exist
    • Slot must not be expired (expiration time >= current time or null)
    • New expiration must be in the future

    Parameters

    • context: IReadableContext

      Readable execution context for the operation
    • key: string

      The semaphore identifier
    • slotId: string

      The slot to update
    • expiration: Date

      New expiration time (or null for persistent)

    Returns Promise<number>

    Number of rows affected (1 if updated, 0 if slot not found or expired)