Type Alias IDatabaseLockAdapter

IDatabaseLockAdapter: {
    find(key: string): Promise<null | ILockData>;
    remove(key: string): Promise<null | ILockExpirationData>;
    removeIfOwner(key: string, lockId: string): Promise<null | ILockData>;
    transaction<TReturn>(
        fn: InvokableFn<
            [transaction: IDatabaseLockTransaction],
            Promise<TReturn>,
        >,
    ): Promise<TReturn>;
    updateExpiration(
        key: string,
        lockId: string,
        expiration: Date,
    ): Promise<number>;
}

The IDatabaseLockAdapter contract defines a way for managing locks independent of data storage. This contract simplifies the implementation of lock adapters with CRUD-based databases, such as SQL databases and ORMs like TypeOrm and MikroOrm.

IMPORT_PATH: "@daiso-tech/core/lock/contracts"

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.
  - Defined in src/lock/contracts/database-lock-adapter.contract.ts:94
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>
  - Defined in src/lock/contracts/database-lock-adapter.contract.ts:63
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.
  - Defined in src/lock/contracts/database-lock-adapter.contract.ts:72
transaction:function
- transaction<TReturn>(
      fn: InvokableFn<
          [transaction: IDatabaseLockTransaction],
          Promise<TReturn>,
      >,
  ): Promise<TReturn>
- Type Parameters
  - TReturn
  Parameters
  - fn: InvokableFn<[transaction: IDatabaseLockTransaction], Promise<TReturn>>
  Returns Promise<TReturn>
  - Defined in src/lock/contracts/database-lock-adapter.contract.ts:51
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.
  - Defined in src/lock/contracts/database-lock-adapter.contract.ts:82

Type Alias IDatabaseLockAdapter

Type declaration

find:function

Parameters

Returns Promise<null | ILockData>

remove:function

Parameters

Returns Promise<null | ILockExpirationData>

removeIfOwner:function

Parameters

Returns Promise<null | ILockData>

transaction:function

Type Parameters

Parameters

Returns Promise<TReturn>

updateExpiration:function

Parameters

Returns Promise<number>

Settings