Type Alias IDatabaseWriterLockTransaction

Type declaration

• find:function

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

  • Parameters

    • key: string

    Returns Promise<null | IWriterLockData>

• remove:function

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

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

    Parameters

    • key: string

      The unique identifier for the lock to remove.

    Returns Promise<null | IWriterLockExpirationData>

• removeIfOwner:function

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

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

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

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

• upsert:function

  • upsert(key: string, lockId: string, expiration: null | Date): Promise<void>

  • Parameters

    • key: string
    • lockId: string
    • expiration: null | Date

    Returns Promise<void>