Interface ILockProvider

acquire

• acquire<T>(
      key: string,
      callback: () => Promise<T>,
      options: { maxOccupationTime: number; timeout: number },
  ): Promise<T>

  Type Parameters

  • T

  Parameters

  • key: string

    the key of the resource to lock
  • callback: () => Promise<T>

    the code which should run once the lock was acquired
  • options: { maxOccupationTime: number; timeout: number }

    • maxOccupationTime: number

      how long to wait until the code in callback is finished

    • timeout: number

      how long to wait until the lock is acquired

  Returns Promise<T>

  Throws

  'timeout' or 'occupation-time-exceed' errors