Documentation / listr2 / ListrTaskObject

Interface: ListrTaskObject<Ctx, Renderer, FallbackRenderer>

Defined in: packages/listr2/src/lib/task.ts:24

Creates and handles a runnable instance of the Task.

Extends

• ListrTaskEventManager

Type Parameters

Ctx

Ctx

Renderer

Renderer extends ListrRendererFactory = ListrRendererFactory

FallbackRenderer

FallbackRenderer extends ListrRendererFactory = ListrRendererFactory

Properties

id

id: string

Defined in: packages/listr2/src/lib/task.ts:30

Unique id per task, can be used for identifying a Task.

---

state

state: ListrTaskState = ListrTaskState.WAITING

Defined in: packages/listr2/src/lib/task.ts:32

The current state of the task.

---

subtasks

subtasks: Task<Ctx, Renderer, FallbackRenderer>[]

Defined in: packages/listr2/src/lib/task.ts:34

Subtasks of the current task.

---

title?

optional title?: string

Defined in: packages/listr2/src/lib/task.ts:36

Title of the task.

---

initialTitle?

readonly optional initialTitle?: string

Defined in: packages/listr2/src/lib/task.ts:38

Initial/Untouched version of the title for using whenever task has a reset.

---

output?

optional output?: string

Defined in: packages/listr2/src/lib/task.ts:40

Output channel for the task.

---

retry?

optional retry?: ListrTaskRetry

Defined in: packages/listr2/src/lib/task.ts:42

Current state of the retry process whenever the task is retrying.

---

message

message: ListrTaskMessage = {}

Defined in: packages/listr2/src/lib/task.ts:48

A channel for messages.

This requires a separate channel for messages like error, skip or runtime messages to further utilize in the renderers.

---

prompt

prompt: ListrPromptAdapter

Defined in: packages/listr2/src/lib/task.ts:50

Current prompt instance or prompt error whenever the task is prompting.

---

parent?

optional parent?: Task<Ctx, any, any>

Defined in: packages/listr2/src/lib/task.ts:52

Parent task of the current task.

---

listr

listr: Listr<Ctx, Renderer, FallbackRenderer>

Defined in: packages/listr2/src/lib/task.ts:62

---

task

task: ListrTask<Ctx, Renderer, FallbackRenderer>

Defined in: packages/listr2/src/lib/task.ts:63

---

options

options: ListrOptions

Defined in: packages/listr2/src/lib/task.ts:64

---

rendererOptions

rendererOptions: ListrGetRendererOptions<FallbackRenderer> | ListrGetRendererOptions<Renderer>

Defined in: packages/listr2/src/lib/task.ts:65

---

rendererTaskOptions

rendererTaskOptions: ListrGetRendererTaskOptions<FallbackRenderer> | ListrGetRendererTaskOptions<Renderer>

Defined in: packages/listr2/src/lib/task.ts:67

Per-task options for the current renderer of the task.

Accessors

state$

Set Signature

set state$(state): void

Defined in: packages/listr2/src/lib/task.ts:85

Update the current state of the Task and emit the neccassary events.

Parameters

state

ListrTaskState

Returns

void

---

output$

Set Signature

set output$(data): void

Defined in: packages/listr2/src/lib/task.ts:105

Update the current output of the Task and emit the neccassary events.

Parameters

data

string

Returns

void

---

outputReset$

Set Signature

set outputReset$(data): void

Defined in: packages/listr2/src/lib/task.ts:115

Reset the current output of the Task and emit the neccassary events.

Parameters

data

null

Returns

void

---

promptOutput$

Set Signature

set promptOutput$(data): void

Defined in: packages/listr2/src/lib/task.ts:125

Update the current prompt output of the Task and emit the neccassary events.

Parameters

data

string

Returns

void

---

message$

Set Signature

set message$(data): void

Defined in: packages/listr2/src/lib/task.ts:138

Update or extend the current message of the Task and emit the neccassary events.

Parameters

data

ListrTaskMessage

Returns

void

---

title$

Set Signature

set title$(title): void

Defined in: packages/listr2/src/lib/task.ts:148

Update the current title of the Task and emit the neccassary events.

Parameters

title

string

Returns

void

---

path

Get Signature

get path(): string[]

Defined in: packages/listr2/src/lib/task.ts:158

Current task path in the hierarchy.

Returns

string[]

Methods

emit()

emit<E>(dispatch, args?): void

Defined in: packages/listr2/src/lib/event-manager.ts:12

Type Parameters

E

E extends ListrTaskEventType = ListrTaskEventType

Parameters

dispatch

E

args?

EventData<E, ListrTaskEventMap>

Returns

void

Inherited from

ListrTaskEventManager.emit

---

on()

on<E>(dispatch, handler): void

Defined in: packages/listr2/src/lib/event-manager.ts:16

Type Parameters

E

E extends ListrTaskEventType = ListrTaskEventType

Parameters

dispatch

E

handler

(data) => void

Returns

void

Inherited from

ListrTaskEventManager.on

---

once()

once<E>(dispatch, handler): void

Defined in: packages/listr2/src/lib/event-manager.ts:24

Type Parameters

E

E extends ListrTaskEventType = ListrTaskEventType

Parameters

dispatch

E

handler

(data) => void

Returns

void

Inherited from

ListrTaskEventManager.once

---

off()

off<E>(dispatch, handler?): void

Defined in: packages/listr2/src/lib/event-manager.ts:32

Type Parameters

E

E extends ListrTaskEventType = ListrTaskEventType

Parameters

dispatch

E

handler?

(data) => void

Returns

void

Inherited from

ListrTaskEventManager.off

---

complete()

complete(): void

Defined in: packages/listr2/src/lib/event-manager.ts:40

Returns

void

Inherited from

ListrTaskEventManager.complete

---

check()

check(ctx): Promise<boolean>

Defined in: packages/listr2/src/lib/task.ts:165

Checks whether the current task with the given context should be set as enabled.

Parameters

ctx

Ctx

Returns

Promise<boolean>

---

hasSubtasks()

hasSubtasks(): boolean

Defined in: packages/listr2/src/lib/task.ts:178

Returns whether this task has subtasks.

Returns

boolean

---

hasFinalized()

hasFinalized(): boolean

Defined in: packages/listr2/src/lib/task.ts:183

Returns whether this task is finalized in someform.

Returns

boolean

---

isPending()

isPending(): boolean

Defined in: packages/listr2/src/lib/task.ts:188

Returns whether this task is in progress.

Returns

boolean

---

isStarted()

isStarted(): boolean

Defined in: packages/listr2/src/lib/task.ts:193

Returns whether this task has started.

Returns

boolean

---

isSkipped()

isSkipped(): boolean

Defined in: packages/listr2/src/lib/task.ts:198

Returns whether this task is skipped.

Returns

boolean

---

isCompleted()

isCompleted(): boolean

Defined in: packages/listr2/src/lib/task.ts:203

Returns whether this task has been completed.

Returns

boolean

---

hasFailed()

hasFailed(): boolean

Defined in: packages/listr2/src/lib/task.ts:208

Returns whether this task has been failed.

Returns

boolean

---

isCancelled()

isCancelled(): boolean

Defined in: packages/listr2/src/lib/task.ts:213

Returns whether this task has been cancelled by an interruption.

Returns

boolean

---

isRollingBack()

isRollingBack(): boolean

Defined in: packages/listr2/src/lib/task.ts:218

Returns whether this task has an active rollback task going on.

Returns

boolean

---

hasRolledBack()

hasRolledBack(): boolean

Defined in: packages/listr2/src/lib/task.ts:223

Returns whether the rollback action was successful.

Returns

boolean

---

isRetrying()

isRetrying(): boolean

Defined in: packages/listr2/src/lib/task.ts:228

Returns whether this task has an actively retrying task going on.

Returns

boolean

---

hasReset()

hasReset(): boolean

Defined in: packages/listr2/src/lib/task.ts:233

Returns whether this task has some kind of reset like retry and rollback going on.

Returns

boolean

---

isEnabled()

isEnabled(): boolean

Defined in: packages/listr2/src/lib/task.ts:238

Returns whether enabled function resolves to true.

Returns

boolean

---

hasTitle()

hasTitle(): boolean

Defined in: packages/listr2/src/lib/task.ts:243

Returns whether this task actually has a title.

Returns

boolean

---

isPrompt()

isPrompt(): boolean

Defined in: packages/listr2/src/lib/task.ts:248

Returns whether this task has a prompt inside.

Returns

boolean

---

isPaused()

isPaused(): boolean

Defined in: packages/listr2/src/lib/task.ts:253

Returns whether this task is currently paused.

Returns

boolean

---

isClosed()

isClosed(): boolean

Defined in: packages/listr2/src/lib/task.ts:258

Returns whether this task is closed.

Returns

boolean

---

pause()

pause(time): Promise<void>

Defined in: packages/listr2/src/lib/task.ts:263

Pause the given task for certain time.

Parameters

time

number

Returns

Promise<void>

---

run()

run(context, wrapper): Promise<void>

Defined in: packages/listr2/src/lib/task.ts:279

Run the current task.

Parameters

context

Ctx

wrapper

ListrTaskWrapper<Ctx, Renderer, FallbackRenderer>

Returns

Promise<void>