Type Alias IDatabaseLockAdapter

IDatabaseLockAdapter: {
    find(key: string): PromiseLike<null | ILockData>;
    insert(
        key: string,
        owner: string,
        expiration: null | Date,
    ): PromiseLike<void>;
    refresh(key: string, owner: string, expiration: Date): PromiseLike<number>;
    remove(key: string, owner: null | string): PromiseLike<void>;
    update(
        key: string,
        owner: string,
        expiration: null | Date,
    ): PromiseLike<number>;
}

The ILockAdapter contract defines a way for managing locks independent of data storage. This contract is not meant to be used directly, instead you should use ILockProvider contract.

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

Type declaration

  • find:function
  • insert:function
    • insert(key: string, owner: string, expiration: null | Date): PromiseLike<void>

    • The insert method will create a lock if one does not already exist.

      Parameters

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

      Returns PromiseLike<void>

  • refresh:function
    • refresh(key: string, owner: string, expiration: Date): PromiseLike<number>

    • The refresh method will upadte expiration of lock if it matches the given key and matches the given owner. Returns number of updated rows or documents.

      Parameters

      • key: string
      • owner: string
      • expiration: Date

      Returns PromiseLike<number>

  • remove:function
    • remove(key: string, owner: null | string): PromiseLike<void>

    • The remove method will remove a lock if it matches the given key and matches the given owner.

      Parameters

      • key: string
      • owner: null | string

      Returns PromiseLike<void>

  • update:function
    • update(key: string, owner: string, expiration: null | Date): PromiseLike<number>

    • The update method will update a lock if it has expired, matches the given key and matches the given owner. Returns number of updated rows or documents.

      Parameters

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

      Returns PromiseLike<number>

Settings

Member Visibility