Skip to content

Documentation / listr2 / ListrTaskState

Enumeration: ListrTaskState

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"

Task has not started yet, waiting for pick-up.

Source

packages/listr2/src/constants/listr-task-state.constants.ts:8


STARTED

STARTED: "STARTED"

Task has started.

Source

packages/listr2/src/constants/listr-task-state.constants.ts:10


COMPLETED

COMPLETED: "COMPLETED"

Task has been completed.

Source

packages/listr2/src/constants/listr-task-state.constants.ts:12


FAILED

FAILED: "FAILED"

Task has failed.

Source

packages/listr2/src/constants/listr-task-state.constants.ts:14


SKIPPED

SKIPPED: "SKIPPED"

Task has been skipped.

Source

packages/listr2/src/constants/listr-task-state.constants.ts:16


ROLLING_BACK

ROLLING_BACK: "ROLLING_BACK"

Task is currently trying to rollback.

Source

packages/listr2/src/constants/listr-task-state.constants.ts:18


ROLLED_BACK

ROLLED_BACK: "ROLLED_BACK"

Task has rolledback successfully after failing.

Source

packages/listr2/src/constants/listr-task-state.constants.ts:20


RETRY

RETRY: "RETRY"

Task is currently retrying.

Source

packages/listr2/src/constants/listr-task-state.constants.ts:22


PAUSED

PAUSED: "PAUSED"

Task is currently paused.

Source

packages/listr2/src/constants/listr-task-state.constants.ts:24


PROMPT

PROMPT: "PROMPT"

Task is currently trying to process a prompt.

Source

packages/listr2/src/constants/listr-task-state.constants.ts:26


PROMPT_COMPLETED

PROMPT_COMPLETED: "PROMPT_COMPLETED"

Task has successfully processed the prompt.

Source

packages/listr2/src/constants/listr-task-state.constants.ts:28


PROMPT_FAILED

PROMPT_FAILED: "PROMPT_FAILED"

Task has failed to process the prompt.

Source

packages/listr2/src/constants/listr-task-state.constants.ts:30