Class RemoteLockStore

Lock Store API

Implements

ILockStore

Index

Constructors

Properties

heartbeatInterval locksHeld store

Methods

heartbeat release startHeartbeat stopHeartbeat tryAcquire

Constructors

constructor

new RemoteLockStore(store): RemoteLockStore
Parameters
- store: RemoteStore
Returns RemoteLockStore
- Defined in lib/core/stores/remote.ts:397

Properties

`Private` heartbeatInterval

heartbeatInterval: null | number = null

`Private` locksHeld

locksHeld: number = 0

`Private` store

store: RemoteStore

Methods

`Private` heartbeat

heartbeat(): Promise<void>
Returns Promise<void>
- Defined in lib/core/stores/remote.ts:459

release

release(resourceId, executionId): Promise<boolean>
Release a lock.
Parameters
- resourceId: string
  Id of lock.
- executionId: string
  Execution id of lock.
Returns Promise<boolean>
Implementation of ILockStore.release
- Defined in lib/core/stores/remote.ts:426

`Private` startHeartbeat

startHeartbeat(): void
Returns void
- Defined in lib/core/stores/remote.ts:445

`Private` stopHeartbeat

stopHeartbeat(): void
Returns void
- Defined in lib/core/stores/remote.ts:452

tryAcquire

tryAcquire(resourceId, executionId, expiry?): Promise<boolean>
Try to acquire a lock.
Parameters
- resourceId: string
  Id of lock.
- executionId: string
  Execution id of lock.
- expiry: number = ...
  Time in ms before lock will expire.
Returns Promise<boolean>
A boolean indicating whether or not the lock was acquired.
Implementation of ILockStore.tryAcquire
- Defined in lib/core/stores/remote.ts:399