Skip to content

Documentation / listr2 / ListrTaskMessage

Interface: ListrTaskMessage

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

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

Source

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


error?

optional error: string

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

Source

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


skip?

optional skip: string

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

Source

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


rollback?

optional rollback: string

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

Source

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


retry?

optional retry: ListrTaskRetry

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

Source

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


paused?

optional paused: number

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

Source

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