Class ListrLock

A utility class for managing lock acquisition tasks in Listr2 based workflows.

Index

Properties

ACQUIRE_LOCK_TASK_TITLE DEFAULT_LOCK_ACQUIRE_ATTEMPTS

Methods

newAcquireLockTask

Properties

`Static` `Readonly`ACQUIRE_LOCK_TASK_TITLE

ACQUIRE_LOCK_TASK_TITLE: "Acquire lock" = 'Acquire lock'

The title of the lock acquisition task used by Listr2.

`Static` `Readonly`DEFAULT_LOCK_ACQUIRE_ATTEMPTS

DEFAULT_LOCK_ACQUIRE_ATTEMPTS: 10

The default number of attempts to try acquiring the lock before failing.

Methods

`Static`newAcquireLockTask

newAcquireLockTask(
lock: Lock,
task: SoloListrTaskWrapper<any>,
): Listr<any, any, any>
Creates a new Listr2 task for acquiring a lock with retry logic.
Parameters
- lock: Lock
  the lock to be acquired.
- task: SoloListrTaskWrapper<any>
  the parent task to which the lock acquisition task will be added.
Returns Listr<any, any, any>
a new Listr2 task for acquiring a lock with retry logic.
- Defined in src/core/lock/listr-lock.ts:36