Type Alias IDatabaseLockAdapter

Type declaration

• find:function

  • find(key: string): Promise<null | ILockData>

  • Retrieves the current lock data for a given key.

    Parameters

    • key: string

      The unique identifier for the lock.

    Returns Promise<null | ILockData>

    Returns the lock's owner and expiration data if found, otherwise null.

• remove:function

  • remove(key: string): Promise<null | ILockExpirationData>

  • Removes a lock from the database regardless of its owner.

    Parameters

    • key: string

      The unique identifier for the lock to remove.

    Returns Promise<null | ILockExpirationData>

• removeIfOwner:function

  • removeIfOwner(key: string, lockId: string): Promise<null | ILockData>

  • Removes a lock from the database only if it is currently held by the specified owner.

    Parameters

    • key: string

      The unique identifier for the lock.
    • lockId: string

    Returns Promise<null | ILockData>

    Returns ILockExpirationData | null. The ILockExpirationData data if successfully removed, otherwise null if the lock wasn't found or the owner didn't match.

• transaction:function

  • transaction<TReturn>(
        fn: InvokableFn<
            [transaction: IDatabaseLockTransaction],
            Promise<TReturn>,
        >,
    ): Promise<TReturn>

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

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

    Type Parameters

    • TReturn

    Parameters

    • fn: InvokableFn<[transaction: IDatabaseLockTransaction], Promise<TReturn>>

    Returns Promise<TReturn>

• updateExpiration:function

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

  • Updates the expiration date of a lock if it is currently held by the specified owner.

    Parameters

    • key: string

      The unique identifier for the lock.
    • lockId: string
    • expiration: Date

      The new date and time when the lock should expire.

    Returns Promise<number>

    Returns a number greater than or equal to 1 if the lock's expiration was updated, or 0 if the lock wasn't found or the owner didn't match.