Documentation / listr2 / ListrTaskMessage

Interface: ListrTaskMessage

Defined in: packages/listr2/src/interfaces/task.interface.ts:104

Task can provide additional information depending on the current state of the Task.

TaskMessage is used to propagate these messages to the renderers for displaying them to the end-user.

Properties

duration?

optional duration: number

Defined in: packages/listr2/src/interfaces/task.interface.ts:106

Elapsed time of the current task, whenever the Task completes.

---

error?

optional error: string

Defined in: packages/listr2/src/interfaces/task.interface.ts:108

Error message from the current task, whenever the Task fails.

---

skip?

optional skip: string

Defined in: packages/listr2/src/interfaces/task.interface.ts:110

Skip message from the current task, whenever the Task skips.

---

rollback?

optional rollback: string

Defined in: packages/listr2/src/interfaces/task.interface.ts:112

Rollback message from the current task, whenever the Task finishes rollback.

---

retry?

optional retry: ListrTaskRetry

Defined in: packages/listr2/src/interfaces/task.interface.ts:114

Retry message from the current task, whenever the Task tries to retry.

---

paused?

optional paused: number

Defined in: packages/listr2/src/interfaces/task.interface.ts:116

Holds the time as epoch time of when will this task continue to execute.