Documentation / listr2 / ListrTaskState
Enumeration: ListrTaskState
Defined in: packages/listr2/src/constants/listr-task-state.constants.ts:6
Tasks can be in various states during the execution.
Whenever a state change occurs, the task will emit a module:listr2.ListrTaskEventType.STATE with the appropriate state.
Enumeration Members
WAITING
WAITING:
"WAITING"
Defined in: packages/listr2/src/constants/listr-task-state.constants.ts:8
Task has not started yet, waiting for pick-up.
STARTED
STARTED:
"STARTED"
Defined in: packages/listr2/src/constants/listr-task-state.constants.ts:10
Task has started.
COMPLETED
COMPLETED:
"COMPLETED"
Defined in: packages/listr2/src/constants/listr-task-state.constants.ts:12
Task has been completed.
FAILED
FAILED:
"FAILED"
Defined in: packages/listr2/src/constants/listr-task-state.constants.ts:14
Task has failed.
SKIPPED
SKIPPED:
"SKIPPED"
Defined in: packages/listr2/src/constants/listr-task-state.constants.ts:16
Task has been skipped.
ROLLING_BACK
ROLLING_BACK:
"ROLLING_BACK"
Defined in: packages/listr2/src/constants/listr-task-state.constants.ts:18
Task is currently trying to rollback.
ROLLED_BACK
ROLLED_BACK:
"ROLLED_BACK"
Defined in: packages/listr2/src/constants/listr-task-state.constants.ts:20
Task has rolledback successfully after failing.
RETRY
RETRY:
"RETRY"
Defined in: packages/listr2/src/constants/listr-task-state.constants.ts:22
Task is currently retrying.
PAUSED
PAUSED:
"PAUSED"
Defined in: packages/listr2/src/constants/listr-task-state.constants.ts:24
Task is currently paused.
PROMPT
PROMPT:
"PROMPT"
Defined in: packages/listr2/src/constants/listr-task-state.constants.ts:26
Task is currently trying to process a prompt.
PROMPT_COMPLETED
PROMPT_COMPLETED:
"PROMPT_COMPLETED"
Defined in: packages/listr2/src/constants/listr-task-state.constants.ts:28
Task has successfully processed the prompt.
PROMPT_FAILED
PROMPT_FAILED:
"PROMPT_FAILED"
Defined in: packages/listr2/src/constants/listr-task-state.constants.ts:30
Task has failed to process the prompt.
CANCELLED
CANCELLED:
"CANCELLED"
Defined in: packages/listr2/src/constants/listr-task-state.constants.ts:32
Task has been cancelled by an interruption before it could finish.