Documentation / listr2 / ListrTaskWrapper

Class: ListrTaskWrapper<Ctx, Renderer, FallbackRenderer>

Defined in: packages/listr2/src/lib/task-wrapper.ts:15

The original Task that is defined by the user is wrapped with the TaskWrapper to provide additional functionality.

See

https://listr2.kilic.dev/task/task.html

Type Parameters

Ctx

Ctx

Renderer

Renderer extends ListrRendererFactory

FallbackRenderer

FallbackRenderer extends ListrRendererFactory

Constructors

Constructor

new ListrTaskWrapper<Ctx, Renderer, FallbackRenderer>(task): TaskWrapper<Ctx, Renderer, FallbackRenderer>

Defined in: packages/listr2/src/lib/task-wrapper.ts:16

Parameters

task

ListrTaskObject<Ctx, Renderer, FallbackRenderer>

Returns

TaskWrapper<Ctx, Renderer, FallbackRenderer>

Properties

task

task: ListrTaskObject<Ctx, Renderer, FallbackRenderer>

Defined in: packages/listr2/src/lib/task-wrapper.ts:16

Accessors

title

Get Signature

get title(): string

Defined in: packages/listr2/src/lib/task-wrapper.ts:19

Returns

string

Set Signature

set title(title): void

Defined in: packages/listr2/src/lib/task-wrapper.ts:28

Title of the current task.

See

https://listr2.kilic.dev/task/title.html

Parameters

title

string | any[]

Returns

void

---

output

Get Signature

get output(): string

Defined in: packages/listr2/src/lib/task-wrapper.ts:35

Returns

string

Set Signature

set output(output): void

Defined in: packages/listr2/src/lib/task-wrapper.ts:45

Send output from the current task to the renderer.

See

https://listr2.kilic.dev/task/output.html

Parameters

output

string | any[]

Returns

void

Methods

newListr()

newListr<NewCtx>(task, options?): Listr<NewCtx, any, any>

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

Creates a new set of Listr subtasks.

Type Parameters

NewCtx

NewCtx = Ctx

Parameters

task

ListrTask<NewCtx, Renderer, FallbackRenderer> | ListrTask<NewCtx, Renderer, FallbackRenderer>[] | (parent) => ListrTask<NewCtx, Renderer, FallbackRenderer> | ListrTask<NewCtx, Renderer, FallbackRenderer>[]

options?

ListrSubClassOptions<NewCtx, Renderer, FallbackRenderer>

Returns

Listr<NewCtx, any, any>

See

https://listr2.kilic.dev/task/subtasks.html

---

report()

report(error, type): void

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

Report an error that has to be collected and handled.

Parameters

error

Error

type

ListrErrorTypes

Returns

void

See

https://listr2.kilic.dev/task/error-handling.html

---

skip()

skip(message?, ...metadata?): void

Defined in: packages/listr2/src/lib/task-wrapper.ts:98

Skip the current task.

Parameters

message?

string

metadata?

...any[]

Returns

void

See

https://listr2.kilic.dev/task/skip.html

---

isRetrying()

isRetrying(): ListrTaskRetry

Defined in: packages/listr2/src/lib/task-wrapper.ts:111

Check whether this task is currently in a retry state.

Returns

ListrTaskRetry

See

https://listr2.kilic.dev/task/retry.html

---

prompt()

prompt<T>(adapter): T

Defined in: packages/listr2/src/lib/task-wrapper.ts:124

Create a new prompt for getting user input through the prompt adapter. This will create a new prompt through the adapter if the task is not currently rendering a prompt or will return the active instance.

This part of the application requires optional peer dependencies, please refer to documentation.

Type Parameters

T

T extends ListrPromptAdapter = ListrPromptAdapter

Parameters

adapter

(task, wrapper) => T

Returns

T

See

https://listr2.kilic.dev/task/prompt.html

---

stdout()

stdout(type?): WritableStream

Defined in: packages/listr2/src/lib/task-wrapper.ts:140

Generates a fake stdout for your use case, where it will be tunnelled through Listr to handle the rendering process.

Parameters

type?

PROMPT | OUTPUT

Returns

WritableStream

See

https://listr2.kilic.dev/renderer/process-output.html

---

run()

run(ctx): Promise<void>

Defined in: packages/listr2/src/lib/task-wrapper.ts:155

Run this task.

Parameters

ctx

Ctx

Returns

Promise<void>