Class: RunLock

RunLock

Source:

Members

(readonly) success :boolean

True if the lock is acquired.

See Task.acquireLock() for more information

Type:
  • boolean
Source:

Methods

release(forceopt) → {Promise.<boolean>}

Releases the lock.

If the lock was acquired (RunLock.success is true), this method releases the lock. If the lock is acquired by another run:

  • the lock is not released,
  • a warning message is logged in the run log,
  • the method returns false

If there is an unexpected error while releasing the lock:
  • the error is logged in the run log,
  • the method returns false

Optionally, use the force parameter to release a lock that was acquired by another Run.
Parameters:
Name Type Attributes Description
force boolean <optional>
 force releasing the lock.
Source:
Returns:
True if the lock was released, false otherwise.
Type
Promise.<boolean>