Class ProcessLocker

Hierarchy

ProcessLocker

Index

Constructors

Methods

acquireLock isLocked tryLock

Constructors

constructor

new ProcessLocker(): ProcessLocker
Returns ProcessLocker

Methods

acquireLock

acquireLock(id: string, ttl?: number, timeout?: number): Promise<ProcessLock>
Parameters
- id: string
- ttl: number = 0
  
  optional defines when the times automatically unlocks.
- timeout: number = 0
  
  if after timeout seconds the lock isn't acquired, it throws an error.
Returns Promise<ProcessLock>
- Defined in packages/core/src/process-locker.ts:131

isLocked

isLocked(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in packages/core/src/process-locker.ts:148

tryLock

tryLock(id: string, ttl?: number): Promise<undefined | ProcessLock>
Parameters
- id: string
- ttl: number = 0
Returns Promise<undefined | ProcessLock>
- Defined in packages/core/src/process-locker.ts:138

Generated using TypeDoc